La doc » Historique » Révision 13
Révision 12 (Geoffroy Desvernay, 20/09/2013 16:39) → Révision 13/18 (Geoffroy Desvernay, 20/09/2013 16:40)
h1. Présentation de la forge
{{>toc}}
La forge peut vous aider dans tous vos projets logiciels. Elle dispose :
* D’une page _Activité_ résumant les dernières actions effectuées. Vous pouvez vous abonner à son flux RSS. Vous pouvez également choisir la quantité d’informations à afficher et à recevoir par mail.
* D’un système de _Demandes_ pour répartir les tâches dans le groupe, garder une trace de ce qui a été fait, planifier en mettant une date d’échéance.
* D’un _Gantt_ qui se complète automatiquement à partir du système de tâche. Il est exportable en pdf.
* D’un calendrier qui se complète automatiquement à partir du système de tâche.
* D’un système d’ _Annonces_ pour communiquer avec l’extérieur.
* D’un moyen de déposer des _Documents_. Vous pouvez donner un titre à ce document et une description longue. Très utile pour rassembler les documents les plus importants à transmettre.
* D’un _Wiki_, pour garder une trace de votre documentation avec un bel historique. Très utile si vous devez la passer à une future équipe. Vous pouvez également attacher un fichier à une page.
* D’un _Dépôt_ pour garder une trace de votre code, pouvoir revenir à une version antérieure qui fonctionne, garder une trace de qui à fait quoi, de comparer des versions,…
Bonne utilisation !
h1. Wiki
Pour créer une nouvelle page, il suffit de se rendre à l’adresse de la page que l’on veut créer.
Pour créer une sous-page (ce qui permet d’avoir une relation parent/enfant entre les pages et de voir la relation dans _Index par titre_), créez les deux pages séparément. Ensuite, allez sur la page fille et cliquez sur renommer. Sélectionnez le nom de la page parent et sauvegardez.
Pour ajouter une table des matières, entrez <pre>{{toc}}</pre>
Vous pouvez aussi recevoir des notifications par mails en cliquant sur _watch_ ou _surveiller_.
Pour ajouter des notes, utilisez les balises suivantes :
<pre>
{{note(text)}}
{{tip(text)}}
{{important(text)}}
{{warning(text)}}
</pre>
h1. Utilisation de Git
Adresse du dépôt git : LOGIN@scm.centrale-marseille.fr:/srv/git/PROJET/default.git
Pour ajouter des utilisateurs au projet, il faut se rapprocher du CRI. Pour deux raisons :
* Les utilisateurs doivent être connus de Redmine
* Les utilisateurs doivent avoir les droits de commit. Ceci implique d’être dans le bon groupe Unix.
{{important(*L’encodage par défaut du dépôt est UTF-8*. Faîtes-y attention surtout si l’encodage de votre système est différent (Vous êtes sous Windows ou linux > 10 ans).)}}
Pour avoir une présentation de git et quelques commandes de base : http://www.llaumgui.com/public/slides/git-github-social-codding/#/
h2. Les clés ssh
h3. Généralités sur ssh
Les clés ssh sont une application de la cryptographie asymétrique dans le but de se connecter à une machine distante. Explications :
L'utilisateur A désire se connecter au serveur ECM de façon sécurisée sans avoir à entrer en permance un mot de passe (qui peut s'oublier, être découvert). Pour cela, il va générer une paire de clés ssh :
* une clé privée qu'il gardera précieusement
* une clé publique à placer sur le serveur.
Pour placer ladite clé sur le serveur, il faut (en général) s'y connecter par mot de passe.
Lorsque A va vouloir se connecter à ECM, son client ssh va tout d'abord regarder si des clés sont disponibles. Ici, A va tenter de se connecter avec sa clé privée. Comme sa clé publique est sur le serveur et qu'un couple de clés est unique, ECM sait que celui qui veut se connecter est A. Il autorise donc la connection.
Notons enfin que lors de la première tentative de connection au serveur, le client demande si on désire accepter la clé publique du serveur. Celle-ci va en effet être utilisée pour le reconnaitre par la suite. Il est évidemment recommandé de ne pas accepter de clés de serveur inconnus.
h3. ssh sous GNU/Linux et autres Unix (*BSD, MacOS, etc.)
L'accès au dépôt se fait par clés ssh. Vous devez donc autoriser la connection à l'aide de votre paire de clé (vous pouvez également procéder de même pour vous connecter en ssh à vos comptes personnels ou d’association, il faut juste adapter les dossiers et les machines).
Pour créer une paire de clé ssh, lancez la commande : <code>ssh-keygen</code>. Ceci crée deux fichiers dans votre ~/.ssh :
* id_rsa (votre clé privée à conserver précieusement)
* id_rsa.pub (votre clé publique à transmettre).
Commande pour créer une paire de clés ssh dans un fichier dont on choisit le nom et le commentaire directement : <code>ssh-keygen -f nom_du_fichier -C commentaire</code>
Pour pouvoir utiliser votre clé publique ssh (~/.ssh/id_rsa.pub) dans le fichier authorized_keys dans votre compte de l'école (eg sur le sas) :
* si la clé est dans votre compte:
* <code>cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_key</code>
* si elle est sur votre machine perso, *au choix* :
* <code>ssh-copy-id login@sas1.ec-m.fr</code> (recommandé)
* <code>ssh-copy-id -i nom_du_fichier_sans_extension_pub login@sas1.ec-m.fr</code> *si vous avez votre clé dans un autre fichier que id_rsa* (recommandé)
* <code>cat ~/.ssh/id_rsa.pub | ssh LOGIN@sas1.ec-m.fr 'mkdir -m 700 -p ~/.ssh ; cat >> .ssh/authorized_keys'</code>
Vous pouvez avoir plusieurs couple de clés ssh sur votre machine (une par serveur par exemple). Auquel cas, leur donner un nom plus explicite peut s'avérer utile.
Dans votre dossier _.ssh_, vous pouvez aussi créer un fichier _config_ pour, entre autre chose, créer un alias d'hôte ce qui vous évitera de taper par exemple _ssh assos@sas1.centrale-marseille.fr_ mais juste _ssh drupal_ (vous pourriez aussi utiliser un alias bash ou affilié pour atteindre ce but). Cette configuration est aussi valable avec scp et peut vous procurer une complétion des chemins sur l'hôte distant.
Si vous avez plusieurs clés sur votre machine, le fichier config s'avèrera obligatoire sinon, la bonne clé ne sera pas utilisée. exemple de fichier ~/.ssh/config :
<pre>
<code>
host drupal
hostname sas1.centrale-marseille.fr
IdentityFile ~/.ssh/nom_du_fichier_sans_extension_pub
user assos
port 22
</code>
</pre>
Si vous avez créé une clé avec une passphrase, celle-ci vous sera demandé à chaque connexion. Il existe des logiciels comme "ssh-agent":http://en.wikipedia.org/wiki/Ssh-agent pour la stocker en mémoire temporairement.
h3. ssh sous windows
{{important(Pour utiliser ssh avec git, nous recommandons de lire [[La_doc#git-sous-Windows|git sous windows avant. Ce paragraphe est surtout intéressant pour une utilisation "stand-alone" de ssh.]])}}
Windows ne fournit pas de client ssh par défaut. Vous devez tout d'abord en installer un. Nous vous recommandons "putty":http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html qui s'exécute directement dans le dossier où il est. Allez sur "ce tuto":http://assos.centrale-marseille.fr/ginfo/content/utiliser-un-terminal-unix-comme-si-vous-%C3%A9tiez-au-cri pour plus de détails.
Néanmoins, ceci ne vous permet que d’avoir une console et pas de générer des clés.
C'est le programme puttygen (disponible "ici":http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html) qui va s'en charger.
# Exécutez-le
# Cliquez sur _Generate_.
# Bouger la souris dans tous les sens (pour ajouter de l'entropie très difficile à obtenir avec une machine par nature déterministe).
# Sauvegardez votre clé publique et votre clé privée là où vous saurez les retrouver. Pensez à remplir le champ _comment_ avec quelque chose qui vous identifie (vote identifiant CAS par exemple). Cela permettra de distinguer les clés ssh sur le serveur. {{note(Donnez leur un nom qui vous permette de les distinguer. Par exemple, key pour votre clé privé et key.pub pour votre clé publique.)}}
{{important(Les clés générées par puttygen ne sont compatibles qu’avec putty)}}
Maintenant, vous devez placer ces clés sur le serveur. Pour cela :
# Connecter vous au serveur avec putty en entrant vote mot de passe
# Créer un dossier .ssh (s’il n’existe pas) <code>mkdir ~/.ssh</code>
# Ouvrez le fichier authorized_keys (ou créez le) : <code>nano -w ~/.ssh/authorized_keys</code>
# Copiez/Collez votre clé publique dedans *sur une seule ligne* avec le commentaire *à la fin* séparé *par une espace* du reste de la ligne.
# Sauvegardez
Ensuite, pour vous connecter au serveur à l’aide de ces clés avec le client putty :
# Ouvrez putty
# Dans Connexion > SSH > Auth, renseignez votre clé privée.
# Connectez vous au serveur comme d’habitude.
h2. git sous Linux et autres Unix
h3. Installer git sous Linux
Git devrait être présent dans les dépôts de votre distribution. Installez-le comme un autre logiciel. Il existe de nombreuses interfaces graphiques tel que la très complète "cola-git":http://git-cola.github.io ou la moins développée "qgit":http://sourceforge.net/projects/qgit/.
h3. Utiliser git sous linux
Classiquement, sous linux, on utilise git en ligne de commande. Voir [[La_doc#Pour-cloner-le-dépôt|comment [[#Pour-cloner-le-dépôt|comment cloner le dépôt]] et [[La_doc#Commandes-basiques-de-git|les [[#Commandes-basiques-de-git|les commandes basiques de git]]. Vous pouvez également utiliser l’une des interfaces plus ou moins complètes citées ci-avant.
h2. git sous Windows
h3. Installer git sous Windows
Il faut tout d’abord installer git, puis installer une interface à git qui facilite sont utilisation en environnement non Unix.
Pour installer git, téléchargez msysgit par "ici":http://code.google.com/p/msysgit/. Installez le avec les paramètres par défaut (ne pas toucher aux composants à installer, puis sur les écrans suivant : _Use Git Bash only_, _Use OpenSSH_ et _Checkout Windows-style, commit Unix-style line endings_).
Vous avez alors un environnement qui vous permet d’utiliser git en ligne de commande via _Git bash_ ou en mode graphique (mais de façon assez basique) via _Git GUI_.
Nous allons maintenant créer des clés ssh. Ces clés vont vous permettre d’utiliser git facilement sur les serveurs de l’école. Vous pouvez passer cette étape et toutes celles concernant ssh pour une installation en local. Remplacez LOGIN par votre login CAS de Centrale Marseille. Pour générer les clés :
# Lancez _Git Bash_
# Tapez les commandes suivantes dans l’interpréteur :
# Pour générer la clé, en laissant les options par défaut (appuyer trois fois sur _Entrée_) : @ssh-keygen -C LOGIN@
# Pour copier la clé sur le serveur (*attention aux apostrophes*). Si c’est la première fois que vous vous connectez au serveur, il vous sera demandé d’accepter sa clé. Répondez _yes_ le cas échéant. : @cat ~/.ssh/id_rsa.pub | ssh LOGIN@sas1.ec-m.fr 'mkdir -m 700 -p ~/.ssh ; cat >> .ssh/authorized_keys'@
# Tester que tout va bien avec : @ssh LOGIN@sas1.centrale-marseille.fr@. On ne vous demande pas votre mot de passe et vous devriez tomber dans une invite de commande. Il est possible que vous ayez à entrer votre passphrase. Pour plus d’infos voir [[Utilisation_de_Git#ssh-sous-GNULinux-et-autres-Unix-BSD-MacOS-etc|utilisation de SSH sous Unix]].
{{important(Pensez à sauvegarder sur *un support sécurisé* le dossier .ssh. Il contient votre clé privée *à ne pas diffuser* et votre clé publique)}}
Afin de vous faciliter la vie, installez également TortoiseGit. C’est une interface à git grâce à laquelle vous pourrez utiliser git et vos clés ssh plus facilement. Téléchargez le logiciel (disponible en version 32 et 64 bits) "ici":http://code.google.com/p/tortoisegit/ et installez-le avec les options par défaut. Pour le configurer, faîtes un clic droit dans un dossier ou sur votre bureau, puis allez dans _TortoiseGit > Settings_. Entrez :
# Le chemin vers msysgit (si vous l’avez installer ailleurs que dans le chemin par défaut)
# Dans l’onglet _Network_, entrez /bin/ssh.exe dans le champ _SSH client_
# Dans l’onglet _git_, entrez votre nom et votre adresse mail.
# *Utilisateurs avancé* : sous l’onglet git, vous pouvez éditer votre .gitconfig directement.
# Enregistrez
h3. Utilisez git sous Windows
Pour cloner un dépôt : utilisez _Git Gui_ (TortoiseGit renvoie une erreur lorsque vous tentez de cloner avec ssh) :
# Lancer _Git GUI_
# Cliquez sur _cloner un dépôt_
# Dans _source_ entrez : @ssh://LOGIN@scm.centrale-marseille.fr/srv/git/NOM_DE_VOTRE_PROJET/default.git
# Dans _Destination_ entrez le chemin du dossier dans lequel vous voulez cloner le dépôt.
# Clonez
Pour toute les autres opérations, TortoiseGit fonctionne très bien. Faîtes un clic droit dans le dossier ou sur un fichier et vous aurez sous le menu TortoiseGit toutes les options disponibles : @git pull@ pour récupérer les données depuis le serveur, @git push@ pour les envoyer (*toujours faire un @git pull@ avant de faire un @git push@ pour éviter les conflits sur le serveur*), @git commit@ pour enregistrer vos modifications dans git,…
h2. Liens complémentaires
* http://www.siteduzero.com/informatique/tutoriels/gerez-vos-codes-source-avec-git/installer-et-configurer-git
* http://melusine.eu.org/syracuse/G/git-windows/
* Liste d’interfaces pour git : http://git-scm.com/downloads/guis
h2. Pour cloner le dépôt
# Placez-vous là où vous voullez cloner le dépôt
# Tapez : <code>git clone ssh://LOGIN@scm.centrale-marseille.fr/srv/git/PROJET/default.git .</code>
h2. Commandes basiques de git
* Pour récupérer les "nouveautés" : <code>git pull</code>
* Pour envoyer ses modifications : <code>git push</code>
{{important(*TOUJOURS* faire un pull et régler les éventuels conflits en local avant de faire un push)}}
* Pour ajouter un fichier au projet : <code>git add <le_fichier></code>
* Pour enregistrer les modifications : <code>git commit <le_fichier></code>
* Pour plus de détails : http://www.siteduzero.com/informatique/tutoriels/gerez-vos-codes-source-avec-git
h2. Fonctionnalités à connaître et exemples d’utilisation
h3. Les branches
Les branches représentent l’une des fonctionnalités les plus puissantes de git. Par défaut toutes les modifications sont faites dans la branche _master_. C’est la branche principale de votre projet.
L’intérêt des branches est de pouvoir faire de grosses modifications en parallèle sans modifier le code principal. Par exemple, vous voulez implémenter une _super idée_. Mais _super idée_ va vous demander du temps de développement et de nombreuses modifications dans votre code. Il serait dommage de paralyser la correction de bug et les petites modifications le temps que _super idée_ soit terminée. C’est là que les branches interviennent : vous créez une nouvelle branche et tous les fichiers seront temporairement remplacés par ceux de cette branche.
Vous pouvez à tous moment réintégrer les modifications d’une branche dans _master_. Vous pouvez également abandonner une branche.
En somme, il devient intéressant de créer une nouvelle branche lorsque :
# La modification est longue
# La modification est compliquée
# L’implémentation de la modification reste un peu floue
Voici les commandes principales associées aux branches :
* Pour voir toutes vos branches locales, utilisez : <code>git branch</code>. La branche marquée d’une étoile est la branche courante.
* Pour créer une nouvelle branche : <code>git branch LE_NOM_DE_MA_BRANCHE</code>.
* Pour changer de branche : <code>git checkout LE_NOM_DE_MA_BRANCHE</code>
{{important(Vous devez avoir commité toutes vos modifications avant de changer de branche)}}
* Pour ajouter les changements dans _master_ : <code>git checkout master ; git merge LE_NOM_DE_MA_BRANCHE</code>
* Pour supprimer une branche : <code>git branch -d LE_NOM_DE_MA_BRANCHE</code>
{{note(Cette commande vérifie avant la suppression que les changements ont bien été ajoutés dans _master_. Pour supprimer une branche sans cette vérification, utilisez _git branch -D LE_NOM_DE_MA_BRANCHE_)}}
Il est évidemment possible de travailler à plusieurs sur une branche autre que master. Pour avoir la liste des branches connues par le serveur, utilisez <code>git branch -r</code>. Pour récupérer cette branche en local : <code>git branch --track NOM_BRANCHE_LOCAL origin/NOM_BRANCHE_SERVEUR</code>.
{{note(Lorsque vous faîtes un pull, seule la branche dans laquelle vous vous trouvez est synchronisée depuis le serveur)}}
Pour ajouter une nouvelle branche sur le serveur, utilisez : <code>git push origin origin:refs/heads/NOM_NOUVELLE_BRANCHE</code>. Vous pouvez ensuite suivre cette branche avec la commande précédente. Si vous avez tout d’abord créé votre branche en local et que vous désirez l’envoyer sur le serveur :
# Créez la branche sur le serveur
# Ouvrez .git/config
# Copiez la partie [branch "master"]
# Remplacez toutes les occurences de "master" par le nom de votre branche
# <code>git pull</code>
# <code>git push</code>
# Normalement, tout est à jour.
Pour supprimer une branche sur le serveur : <code>git push origin :heads/NOM_BRANCHE_A_SUPPRIMER</code>, puis <code>git branch -r -d origin/NOM_BRANCHE_A_SUPPRIMER</code> pour que la branche ne soit plus listée.
Plus d’infos "ici":http://www.siteduzero.com/informatique/tutoriels/gerez-vos-codes-source-avec-git/travailler-avec-des-branches
h3. Les tags
Pour recherche une version plus facilement, vous pouvez tagger un commit avec <code>git tag NOMTAG IDCOMMIT</code>. Vous pourrez ensuite vous référer à ce commit à l’aide de NOMTAG.
{{note(Par défaut les tags ne sont pas envoyés lors d’un push. Utilisez _git push --tag_)}}
h3. La recherche
Grâce à la commande <code>git grep "PATTERN"</code>, vous pouvez recherche dans vos fichiers sources.
h3. Ignorer des fichiers
Si vous désirez que certains fichiers ne soient pas pris en compte par git (fichier de sauvegarde de votre éditeur de texte par exemple), créez un fichier .gitignore dans le dossier de votre dépôt. Ajoutez dans ce fichier le nom des fichiers à ignorer (1 par ligne).
{{note(ps: merci Julien Enselme pour la rédaction initiale de cette page)}}