Projet

Général

Profil

La doc » Historique » Version 16

Geoffroy Desvernay, 09/12/2013 19:09
Mise à jour de la forge

1 10 Geoffroy Desvernay
h1. Présentation de la forge
2 9 Geoffroy Desvernay
3 5 Geoffroy Desvernay
{{>toc}}
4
5
La forge peut vous aider dans tous vos projets logiciels. Elle dispose :
6
7
* 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.
8
* 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.
9
* D’un _Gantt_ qui se complète automatiquement à partir du système de tâche. Il est exportable en pdf.
10
* D’un calendrier qui se complète automatiquement à partir du système de tâche.
11
* D’un système d’ _Annonces_ pour communiquer avec l’extérieur.
12
* 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.
13
* 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.
14
* 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,…
15
16
Bonne utilisation !
17
18 15 Geoffroy Desvernay
h1. Utilisation du Wiki
19 5 Geoffroy Desvernay
20 1 Geoffroy Desvernay
Pour créer une nouvelle page, il suffit de se rendre à l’adresse de la page que l’on veut créer.
21
22
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.
23
24 5 Geoffroy Desvernay
Pour ajouter une table des matières, entrez <pre>{{toc}}</pre>
25 1 Geoffroy Desvernay
26 15 Geoffroy Desvernay
Pour ajouter une table des matières décalée sur la droite, entrez *après un autre texte* (sinon la table des matières se heurte aux boutons de modification, suivi, etc.) <pre>{{>toc}}</pre>
27
28 1 Geoffroy Desvernay
Vous pouvez aussi recevoir des notifications par mails en cliquant sur _watch_ ou _surveiller_.
29
30 5 Geoffroy Desvernay
Pour ajouter des notes, utilisez les balises suivantes :
31 1 Geoffroy Desvernay
32 5 Geoffroy Desvernay
<pre>
33
    {{note(text)}}
34
    {{tip(text)}}
35
    {{important(text)}}
36 1 Geoffroy Desvernay
    {{warning(text)}}
37 15 Geoffroy Desvernay
</pre>
38
39
Pour faire un tableau, il faut utiliser la sy ntaxe suivante :
40
41
<pre>
42
|_. Titre1 |_. Titre2 |
43
| case1 | case2 |
44 5 Geoffroy Desvernay
</pre>
45 1 Geoffroy Desvernay
46 6 Geoffroy Desvernay
h1. Utilisation de Git
47 1 Geoffroy Desvernay
48 16 Geoffroy Desvernay
Adresse du dépôt git : LOGIN@git.centrale-marseille.fr/PROJET.git
49 1 Geoffroy Desvernay
50 6 Geoffroy Desvernay
Pour ajouter des utilisateurs au projet, il faut se rapprocher du CRI. Pour deux raisons :
51 1 Geoffroy Desvernay
52 16 Geoffroy Desvernay
Pour accéder à un dépôt, les utilisateurs doivent: 
53
* être connus de Redmine
54
* Les utilisateurs doivent avoir les droits de commit.
55
* Ils doivent avoir enregistré une cle ssh publique dans leur compte.
56 1 Geoffroy Desvernay
57 6 Geoffroy Desvernay
{{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).)}}
58 5 Geoffroy Desvernay
59 1 Geoffroy Desvernay
Pour avoir une présentation de git et quelques commandes de base : http://www.llaumgui.com/public/slides/git-github-social-codding/#/
60
61
h2. Les clés ssh
62
63 6 Geoffroy Desvernay
h3. Généralités sur ssh
64 1 Geoffroy Desvernay
65 6 Geoffroy Desvernay
Les clés ssh sont une application de la cryptographie asymétrique dans le but de se connecter à une machine distante. Explications :
66 1 Geoffroy Desvernay
67 6 Geoffroy Desvernay
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 :
68
69
* une clé privée qu'il gardera précieusement
70
* une clé publique à placer sur le serveur.
71
72
Pour placer ladite clé sur le serveur, il faut (en général) s'y connecter par mot de passe.
73
74
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.
75
76
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.
77
78
h3. ssh sous GNU/Linux et autres Unix (*BSD, MacOS, etc.)
79
80
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).
81
82 5 Geoffroy Desvernay
Pour créer une paire de clé ssh, lancez la commande : <code>ssh-keygen</code>. Ceci crée deux fichiers dans votre ~/.ssh :
83 6 Geoffroy Desvernay
84 1 Geoffroy Desvernay
* id_rsa (votre clé privée à conserver précieusement)
85
* id_rsa.pub (votre clé publique à transmettre).
86
87
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>
88 6 Geoffroy Desvernay
89 16 Geoffroy Desvernay
Copiez ensuite le contenu du fichier ~/.ssh/id_rsa.pub dans les paramètres de votre compte ('Mon compte' en haut à droite)
90 6 Geoffroy Desvernay
91 16 Geoffroy Desvernay
Vous pouvez avoir plusieurs couple de clés ssh sur votre machine (une par serveur par exemple). Auquel cas, leur donner un nom explicite peut s'avérer utile.
92 1 Geoffroy Desvernay
93 6 Geoffroy Desvernay
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 :
94
95
<pre>
96
<code>
97 16 Geoffroy Desvernay
host          gitecm
98
  hostname      git.centrale-marseille.fr
99 6 Geoffroy Desvernay
  IdentityFile  ~/.ssh/nom_du_fichier_sans_extension_pub
100 16 Geoffroy Desvernay
  user          git
101 6 Geoffroy Desvernay
  port          22
102
</code>
103
</pre>
104
105 1 Geoffroy Desvernay
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.
106
107 6 Geoffroy Desvernay
h3. ssh sous windows
108
109
{{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.]])}}
110
111 11 Geoffroy Desvernay
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.
112 6 Geoffroy Desvernay
113
Néanmoins, ceci ne vous permet que d’avoir une console et pas de générer des clés.
114
115 5 Geoffroy Desvernay
C'est le programme puttygen (disponible "ici":http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html) qui va s'en charger.
116 1 Geoffroy Desvernay
117 6 Geoffroy Desvernay
# Exécutez-le
118 1 Geoffroy Desvernay
# Cliquez sur _Generate_.
119
# Bouger la souris dans tous les sens (pour ajouter de l'entropie très difficile à obtenir avec une machine par nature déterministe).
120 6 Geoffroy Desvernay
# 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.)}}
121 1 Geoffroy Desvernay
{{important(Les clés générées par puttygen ne sont compatibles qu’avec putty)}}
122
123
Maintenant, vous devez placer ces clés sur le serveur. Pour cela :
124 6 Geoffroy Desvernay
125 16 Geoffroy Desvernay
# connectez-vous à la forge, cliquez sur 'mon compte'
126
# Copiez/Collez votre clé publique dans la case 'clé' *sur une seule ligne* avec le commentaire *à la fin* séparé *par une espace* du reste de la ligne. Ajoutez-y un identifiant qui vous permette se vous rappeler d'ou elle vient...
127 1 Geoffroy Desvernay
# Sauvegardez
128
129
h2. git sous Linux et autres Unix
130 6 Geoffroy Desvernay
131 1 Geoffroy Desvernay
h3. Installer git sous Linux
132 6 Geoffroy Desvernay
133 1 Geoffroy Desvernay
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/.
134 6 Geoffroy Desvernay
135 1 Geoffroy Desvernay
h3. Utiliser git sous linux
136 6 Geoffroy Desvernay
137 1 Geoffroy Desvernay
Classiquement, sous linux, on utilise git en ligne de commande. Voir [[La_doc#Pour-cloner-le-dépôt|comment cloner le dépôt]] et [[La_doc#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.
138 13 Geoffroy Desvernay
139 1 Geoffroy Desvernay
h2. git sous Windows
140 6 Geoffroy Desvernay
141 1 Geoffroy Desvernay
h3. Installer git sous Windows
142
143 6 Geoffroy Desvernay
Il faut tout d’abord installer git, puis installer une interface à git qui facilite sont utilisation en environnement non Unix.
144
145
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_).
146
147
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_.
148
149
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 :
150
151
# Lancez _Git Bash_
152
# Tapez les commandes suivantes dans l’interpréteur :
153
154 1 Geoffroy Desvernay
 # Pour générer la clé, en laissant les options par défaut (appuyer trois fois sur _Entrée_) : @ssh-keygen -C LOGIN@
155 16 Geoffroy Desvernay
 # 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@ et copiez-collez le résultat dans 'mon compte' pour ajouter cette clé.
156 6 Geoffroy Desvernay
157 14 Geoffroy Desvernay
{{important(Pensez à sauvegarder sur *un support sécurisé* le dossier .ssh. Il contient votre clé privée *à ne pas diffuser* et votre clé publique)}}
158 6 Geoffroy Desvernay
159
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 :
160
# Le chemin vers msysgit (si vous l’avez installer ailleurs que dans le chemin par défaut)
161
# Dans l’onglet _Network_, entrez /bin/ssh.exe dans le champ _SSH client_
162
# Dans l’onglet _git_, entrez votre nom et votre adresse mail.
163
# *Utilisateurs avancé* : sous l’onglet git, vous pouvez éditer votre .gitconfig directement.
164
# Enregistrez
165
166
h3. Utilisez git sous Windows
167
168
Pour cloner un dépôt : utilisez _Git Gui_ (TortoiseGit renvoie une erreur lorsque vous tentez de cloner avec ssh) :
169
# Lancer _Git GUI_
170
# Cliquez sur _cloner un dépôt_
171 16 Geoffroy Desvernay
# Dans _source_ entrez : @ssh://git@git.centrale-marseille.fr/NOM_DE_VOTRE_PROJET.git
172 6 Geoffroy Desvernay
# Dans _Destination_ entrez le chemin du dossier dans lequel vous voulez cloner le dépôt.
173
# Clonez
174
175
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,…
176
177
h2. Liens complémentaires
178
179 5 Geoffroy Desvernay
* http://www.siteduzero.com/informatique/tutoriels/gerez-vos-codes-source-avec-git/installer-et-configurer-git
180 1 Geoffroy Desvernay
* http://melusine.eu.org/syracuse/G/git-windows/
181 6 Geoffroy Desvernay
* Liste d’interfaces pour git : http://git-scm.com/downloads/guis
182 1 Geoffroy Desvernay
183
h2. Pour cloner le dépôt
184
185
# Placez-vous là où vous voullez cloner le dépôt
186 16 Geoffroy Desvernay
# Tapez : <code>git clone ssh://git@git.centrale-marseille.fr/PROJET.git .</code>
187 1 Geoffroy Desvernay
188
h2. Commandes basiques de git
189
190 5 Geoffroy Desvernay
* Pour récupérer les "nouveautés" : <code>git pull</code>
191
* Pour envoyer ses modifications : <code>git push</code>
192
{{important(*TOUJOURS* faire un pull et régler les éventuels conflits en local avant de faire un push)}}
193
* Pour ajouter un fichier au projet : <code>git add <le_fichier></code>
194
* Pour enregistrer les modifications : <code>git commit <le_fichier></code>
195
* Pour plus de détails : http://www.siteduzero.com/informatique/tutoriels/gerez-vos-codes-source-avec-git
196
197
h2. Fonctionnalités à connaître et exemples d’utilisation
198
199
h3. Les branches
200
201
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.
202
203
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.
204
205
Vous pouvez à tous moment réintégrer les modifications d’une branche dans _master_. Vous pouvez également abandonner une branche.
206
207
En somme, il devient intéressant de créer une nouvelle branche lorsque :
208
# La modification est longue
209
# La modification est compliquée
210
# L’implémentation de la modification reste un peu floue
211
212
Voici les commandes principales associées aux branches :
213
* Pour voir toutes vos branches locales, utilisez : <code>git branch</code>. La branche marquée d’une étoile est la branche courante.
214
* Pour créer une nouvelle branche : <code>git branch LE_NOM_DE_MA_BRANCHE</code>.
215
* Pour changer de branche : <code>git checkout LE_NOM_DE_MA_BRANCHE</code>
216
{{important(Vous devez avoir commité toutes vos modifications avant de changer de branche)}}
217
* Pour ajouter les changements dans _master_ : <code>git checkout master ; git merge LE_NOM_DE_MA_BRANCHE</code>
218
* Pour supprimer une branche : <code>git branch -d LE_NOM_DE_MA_BRANCHE</code>
219
{{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_)}}
220
221
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>.
222
{{note(Lorsque vous faîtes un pull, seule la branche dans laquelle vous vous trouvez est synchronisée depuis le serveur)}}
223
224
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 :
225
# Créez la branche sur le serveur
226
# Ouvrez .git/config
227
# Copiez la partie [branch "master"]
228
# Remplacez toutes les occurences de "master" par le nom de votre branche
229
# <code>git pull</code>
230
# <code>git push</code>
231
# Normalement, tout est à jour.
232
233
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.
234
Plus d’infos "ici":http://www.siteduzero.com/informatique/tutoriels/gerez-vos-codes-source-avec-git/travailler-avec-des-branches
235
236
h3. Les tags
237
238
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.
239
240
{{note(Par défaut les tags ne sont pas envoyés lors d’un push. Utilisez _git push --tag_)}}
241
242
h3. La recherche
243 3 Geoffroy Desvernay
244
Grâce à la commande <code>git grep "PATTERN"</code>, vous pouvez recherche dans vos fichiers sources.
245 1 Geoffroy Desvernay
246
h3. Ignorer des fichiers
247
248
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).
249
{{note(ps: merci Julien Enselme pour la rédaction initiale de cette page)}}