Project

General

Profile

Utilisation de Redmine » History » Version 42

Julien Enselme, 05/29/2013 12:10 AM

1 9 Julien Enselme
{{toc}}
2 19 Ismaeil Abouljamal
3 21 Ismaeil Abouljamal
h1. Wiki d'utilisation du projet multi-assos
4 18 Ismaeil Abouljamal
5 18 Ismaeil Abouljamal
Voir le lien [[Utilisation_de_Drupal_multi-site]]
6 9 Julien Enselme
7 41 Julien Enselme
h1. Présentation de la forge
8 41 Julien Enselme
9 41 Julien Enselme
La forge peut vous aider dans tous vos projets logiciels. Elle dispose :
10 41 Julien Enselme
11 41 Julien Enselme
* 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.
12 41 Julien Enselme
* 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.
13 41 Julien Enselme
* D’un _Gantt_ qui se complète automatiquement à partir du système de tâche. Il est exportable en pdf.
14 41 Julien Enselme
* D’un calendrier qui se complète automatiquement à partir du système de tâche.
15 41 Julien Enselme
* D’un système d’ _Annonces_ pour communiquer avec l’extérieur.
16 41 Julien Enselme
* 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.
17 41 Julien Enselme
* 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.
18 41 Julien Enselme
* 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,…
19 41 Julien Enselme
20 41 Julien Enselme
Bonne utilisation !
21 41 Julien Enselme
22 3 Julien Enselme
h1. Wiki
23 3 Julien Enselme
24 3 Julien Enselme
Pour créer une nouvelle page, il suffit de se rendre à l’adresse de la page que l’on veut créer.
25 3 Julien Enselme
26 8 Julien Enselme
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.
27 9 Julien Enselme
28 9 Julien Enselme
Pour ajouter une table des matières, entrez <pre>{{toc}}</pre>
29 3 Julien Enselme
30 22 Julien Enselme
Vous pouvez aussi recevoir des notifications par mails en cliquant sur _watch_ ou _surveiller_.
31 1 Julien Enselme
32 22 Julien Enselme
Pour ajouter des notes, utilisez les balises suivantes :
33 22 Julien Enselme
34 22 Julien Enselme
<pre>
35 22 Julien Enselme
    {{note(text)}}
36 22 Julien Enselme
    {{tip(text)}}
37 22 Julien Enselme
    {{important(text)}}
38 1 Julien Enselme
    {{warning(text)}}
39 22 Julien Enselme
</pre>
40 1 Julien Enselme
41 22 Julien Enselme
h1. Dépôt git
42 22 Julien Enselme
43 24 Julien Enselme
Adresse du dépôt git : LOGIN@scm.centrale-marseille.fr:/srv/git/PROJET/default.git
44 2 Julien Enselme
45 24 Julien Enselme
Pour ajouter des utilisateurs au projet : il faut se rapprocher du CRI. Pour deux raisons :
46 1 Julien Enselme
* Les utilisateurs doivent être connus de Redmine
47 1 Julien Enselme
* Les utilisateurs doivent avoir les droits de commit. Ceci implique d’être dans le bon groupe Unix.
48 1 Julien Enselme
49 24 Julien Enselme
{{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).)}}
50 1 Julien Enselme
51 42 Julien Enselme
Pour avoir une présentation de git et quelques commandes de base : http://www.llaumgui.com/public/slides/git-github-social-codding/#/
52 42 Julien Enselme
53 1 Julien Enselme
h2. Les clés ssh
54 1 Julien Enselme
55 24 Julien Enselme
h3. Sous linux
56 1 Julien Enselme
57 24 Julien Enselme
L'accès au dépôt se fait par les clés ssh autorisées dans vos comptes de l'école. 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.
58 24 Julien Enselme
59 36 Julien Enselme
Pour créer une paire de clé ssh, lancez la commande : <code>ssh-keygen</code>. Ceci crée deux fichiers dans votre ~/.ssh :
60 36 Julien Enselme
* id_rsa (votre clé privée à conserver précieusement)
61 36 Julien Enselme
* id_rsa.pub (votre clé publique à transmettre).
62 1 Julien Enselme
63 36 Julien Enselme
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) :
64 1 Julien Enselme
65 24 Julien Enselme
* si la clé est dans votre compte:
66 1 Julien Enselme
67 8 Julien Enselme
 * <code>cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_key</code>
68 15 Geoffroy Desvernay
69 24 Julien Enselme
* si elle est sur votre machine perso, *au choix* :
70 1 Julien Enselme
71 1 Julien Enselme
 * <code>ssh-copy-id login@sas1.ec-m.fr</code>
72 24 Julien Enselme
 * <code>cat ~/.ssh/id_rsa.pub | ssh LOGIN@sas1.ec-m.fr 'mkdir -m 700 -p ~/.ssh ; cat >> .ssh/authorized_keys'</code>
73 1 Julien Enselme
74 24 Julien Enselme
h3. Sous windows
75 24 Julien Enselme
76 37 Julien Enselme
Installez un client ssh. Par exemple "ppty":http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html. 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.
77 24 Julien Enselme
78 25 Julien Enselme
Ceci vous permet d’avoir une console. Le programme puttygen (disponible "ici":http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html) vous permet de générer une paire de clé.
79 25 Julien Enselme
# Exécutez-le
80 25 Julien Enselme
# Cliquez sur _Generate_.
81 25 Julien Enselme
# Bouger la souris dans tous les sens.
82 37 Julien Enselme
# 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. 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.)}}
83 25 Julien Enselme
{{important(Les clés générées par puttygen ne sont compatibles qu’avec putty)}}
84 25 Julien Enselme
85 25 Julien Enselme
Maintenant, vous devez placer ces clés sur le serveur. Pour cela :
86 25 Julien Enselme
# Connecter vous au serveur avec putty
87 25 Julien Enselme
# Créer un dossier .ssh (s’il n’existe pas) <code>mkdir ~/.ssh</code>
88 25 Julien Enselme
# Ouvrez le fichier authorized_keys (ou créez le) : <code>nano -w ~/.ssh/authorized_keys</code>
89 28 Julien Enselme
# Copiez/Collez votre clé publique dedans *sur une seule ligne*
90 25 Julien Enselme
# Sauvegardez
91 25 Julien Enselme
92 25 Julien Enselme
Ensuite, pour vous connecter au serveur à l’aide de ces clés avec le client putty :
93 37 Julien Enselme
# Ouvrez putty
94 25 Julien Enselme
# Dans Connexion > SSH > Auth, renseignez votre clé privée.
95 37 Julien Enselme
# Connectez vous au serveur comme d’habitude.
96 25 Julien Enselme
97 25 Julien Enselme
h2. Installer git
98 25 Julien Enselme
99 25 Julien Enselme
h3. Sous Linux
100 25 Julien Enselme
101 25 Julien Enselme
Git devrait être présent dans les dépôts de votre distribution. Installez-le comme un autre logiciel.
102 25 Julien Enselme
103 25 Julien Enselme
h3. Sous Windows
104 25 Julien Enselme
105 38 Julien Enselme
Il faut tout d’abord installer git. Téléchargez msysgit par "ici":http://code.google.com/p/msysgit/. Installez le avec les paramètres par défaut.
106 29 Julien Enselme
107 38 Julien Enselme
Afin de vous faciliter la vie, installez également TortoiseGit. C’est une interface à git grâce à laquelle vous pourrez utiliser vos clés ssh plus facilement. Téléchargez le logiciel "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 comme demander puis sauvegardez.
108 29 Julien Enselme
109 29 Julien Enselme
Pour cloner un dépôt :
110 29 Julien Enselme
# Allez là où vous désirez le cloner
111 29 Julien Enselme
# Clique droit, puis clone
112 29 Julien Enselme
# Entrez le chemin du dépôt
113 38 Julien Enselme
# Cochez _Load Putty key_ et entrez le chemin de votre clé privé dans ce champ.
114 29 Julien Enselme
# Vous êtes opérationnel.
115 29 Julien Enselme
116 29 Julien Enselme
Liens complémentaires :
117 29 Julien Enselme
* http://www.siteduzero.com/informatique/tutoriels/gerez-vos-codes-source-avec-git/installer-et-configurer-git
118 29 Julien Enselme
* http://melusine.eu.org/syracuse/G/git-windows/
119 24 Julien Enselme
120 1 Julien Enselme
h2. Pour cloner le dépôt
121 3 Julien Enselme
122 39 Julien Enselme
# Placez-vous là où vous voullez cloner le dépôt
123 24 Julien Enselme
# Tapez : <code>git clone ssh://LOGIN@scm.centrale-marseille.fr/srv/git/PROJET/default.git .</code>
124 24 Julien Enselme
125 32 Julien Enselme
h2. Commandes basiques de git
126 32 Julien Enselme
127 32 Julien Enselme
* Pour récupérer les "nouveautés" : <code>git pull</code>
128 32 Julien Enselme
* Pour envoyer ses modifications : <code>git push</code>
129 33 Julien Enselme
{{important(*TOUJOURS* faire un pull et régler les éventuels conflits en local avant de faire un push)}}
130 32 Julien Enselme
* Pour ajouter un fichier au projet : <code>git add <le_fichier></code>
131 32 Julien Enselme
* Pour enregistrer les modifications : <code>git commit <le_fichier></code>
132 32 Julien Enselme
* Pour plus de détails : http://www.siteduzero.com/informatique/tutoriels/gerez-vos-codes-source-avec-git
133 32 Julien Enselme
134 40 Julien Enselme
h2. Fonctionnalités à connaître et exemples d’utilisation
135 24 Julien Enselme
136 30 Julien Enselme
h3. Les branches
137 30 Julien Enselme
138 31 Julien Enselme
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.
139 31 Julien Enselme
140 31 Julien Enselme
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.
141 31 Julien Enselme
142 31 Julien Enselme
Vous pouvez à tous moment réintégrer les modifications d’une branche dans _master_. Vous pouvez également abandonner une branche.
143 31 Julien Enselme
144 31 Julien Enselme
En somme, il devient intéressant de créer une nouvelle branche lorsque :
145 31 Julien Enselme
# La modification est longue
146 31 Julien Enselme
# La modification est compliquée
147 31 Julien Enselme
# L’implémentation de la modification reste un peu floue
148 31 Julien Enselme
149 31 Julien Enselme
Voici les commandes principales associées aux branches :
150 31 Julien Enselme
* Pour voir toutes vos branches locales, utilisez : <code>git branch</code>. La branche marquée d’une étoile est la branche courante.
151 31 Julien Enselme
* Pour créer une nouvelle branche : <code>git branch LE_NOM_DE_MA_BRANCHE</code>.
152 31 Julien Enselme
* Pour changer de branche : <code>git checkout LE_NOM_DE_MA_BRANCHE</code>
153 34 Julien Enselme
{{important(Vous devez avoir commité toutes vos modifications avant de changer de branche)}}
154 31 Julien Enselme
* Pour ajouter les changements dans _master_ : <code>git checkout master ; git merge LE_NOM_DE_MA_BRANCHE</code>
155 31 Julien Enselme
* Pour supprimer une branche : <code>git branch -d LE_NOM_DE_MA_BRANCHE</code>
156 31 Julien Enselme
{{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_)}}
157 31 Julien Enselme
158 31 Julien Enselme
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>.
159 31 Julien Enselme
{{note(Lorsque vous faîtes un pull, seule la branche dans laquelle vous vous trouvez est synchronisée depuis le serveur)}}
160 31 Julien Enselme
161 35 Julien Enselme
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 :
162 31 Julien Enselme
# Créez la branche sur le serveur
163 31 Julien Enselme
# Ouvrez .git/config
164 31 Julien Enselme
# Copiez la partie [branch "master"]
165 31 Julien Enselme
# Remplacez toutes les occurences de "master" par le nom de votre branche
166 31 Julien Enselme
# <code>git pull</code>
167 31 Julien Enselme
# <code>git push</code>
168 31 Julien Enselme
# Normalement, tout est à jour.
169 31 Julien Enselme
170 31 Julien Enselme
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.
171 31 Julien Enselme
Plus d’infos "ici":http://www.siteduzero.com/informatique/tutoriels/gerez-vos-codes-source-avec-git/travailler-avec-des-branches
172 30 Julien Enselme
173 30 Julien Enselme
h3. Les tags
174 30 Julien Enselme
175 30 Julien Enselme
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.
176 30 Julien Enselme
177 30 Julien Enselme
{{note(Par défaut les tags ne sont pas envoyés lors d’un push. Utilisez _git push --tag_)}}
178 1 Julien Enselme
179 1 Julien Enselme
h3. La recherche
180 4 Julien Enselme
181 4 Julien Enselme
Grâce à la commande <code>git grep "PATTERN"</code>, vous pouvez recherche dans vos fichiers sources.
182 8 Julien Enselme
183 8 Julien Enselme
h3. Ignorer des fichiers
184 10 Julien Enselme
185 10 Julien Enselme
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).