Difference between revisions of "SVN/En"

From TuxFamilyFAQ
Jump to navigationJump to search
Line 4: Line 4:
  
 
This page is being translated ! The translation is not yet finished, and there could be grammatical errors on the page !!
 
This page is being translated ! The translation is not yet finished, and there could be grammatical errors on the page !!
 
+
Baud123 : DO NOT TOUCH :))
 
= Description =
 
= Description =
  
Line 93: Line 93:
 
The import will recursively copy the content of the repertory directly in the referential.
 
The import will recursively copy the content of the repertory directly in the referential.
  
Si vous avez déjà des fichiers composant le projet, il vous suffit de procéder de la même façon mais de ne faire l'import qu'après avoir copié vos fichiers dans le répertoire trunk.
+
If you already have files for this project, you just have to do the same way, but do the import after you have copied your files in the trunk folder.
  
 
Après cet import, il vous faut faire un checkout du référentiel  
 
Après cet import, il vous faut faire un checkout du référentiel  

Revision as of 00:23, 1 November 2007

SVN Repository



This page is being translated ! The translation is not yet finished, and there could be grammatical errors on the page !! Baud123 : DO NOT TOUCH :))

Description

Subversion was created to replace CVS You can find more informations about SVN [[1]]

Requirements

Creating the SVN repository

  • Go on the control panel
  • Select the project where you want to add a SVN repository
  • Choose the name of your repository
  • Validate

creating tips

  • Don't choose a too usual name
  • Fill the description field to avoid problems with the moderation team ;)

Moderation

Your repository will be subject to moderation, see here

How to administrate it (panel)

On the panel you can choose if you want the repository to be public. By accepting it, you allow a read-only anonymous login on the repository and you allow viewing it from the svnweb

Configuration

How to handle group rights

This object can be shared with your group using the ACL

How to destroy it

  • Log into the panel
  • click on the group corresponding to your project
  • click on your SVN repository
  • click on destroy

How to use it

So, you've chosen to be hosted by tuxfamily, that's good. You chose a subversion repository, that's great ! We're going to teach you how to use it.

Basic Operations

Check out

So, you want to have a basic use of your SVN repository. First, perform a checkout of the repository

svn co svn+ssh://YOURUSER@svn.tuxfamily.org/svnroot/PROJECT/REPO_NAME

(Of course, replace YOURUSER by your user name on the panel, PROJECT by the project owning the repository names REPO_NAME)

Warning, your password may be asked several times. This is not a bug, it is caused by SVN which uses several connections, so you have to enter several times your password, or you can use a SSH key (see below)

To test your access to the SVN referential, you can try something like this :

[soda@evira:/tmp/subversion] svn co svn+ssh://sod@svn.tuxfamily.org/svnroot/vhffs4/vhffs folder
Révision 0 extraite.
[soda@evira:/tmp/subversion] $

Yeah, it's allrigt ! The folder ##folder## has been created. Of course, it's empty, because your referential doesn't include any file.

Creating the base layout

Even though it's not an obligation, you should arrange your referential like this :

SVNROOT
|
|_ branches
|_ tags
|_ trunk

This will help you during the evolution of your project : the folder trunk will always include the last development version, tags will only be here to contain version notes (you should create a tag for each release, it will be easier for the users to know which code is associated to a version) and branches will allow you to add features which are too unstable to be present in the trunk.

First Import

If you have no files yet to put under subversion, you can simply create the layout :

cd /tmp
mkdir monprojet
cd monprojet && mkdir trunk && mkdir branches && mkdir tags
svn import . svn+ssh://UTILISATEUR@svn.tuxfamily.org/svnroot/GROUPE/REPOSITORY -m "Initial import or anything you want."

The import will recursively copy the content of the repertory directly in the referential.

If you already have files for this project, you just have to do the same way, but do the import after you have copied your files in the trunk folder.

Après cet import, il vous faut faire un checkout du référentiel

svn co svn+ssh://USER@svn.tuxfamily.org/svnroot/GROUPE/REPOSITORY unrepertoire

unrepertoire étant le répertoire dans lequel vous allez travailler. Si tous les fichiers sont bien présents, vous pouvez supprimer le répertoire à partir duquel vous avez fait l'import et passer à la suite de ce document.

Add/delete files, update of the repository

Add a file

Entrons donc dans notre répertoire

cd repertoire

Et créons un fichier appelé ##file##

touch file

Ensuite, pour l'ajouter au repository, tapez simplement

svn add file

Enfin, pour envoyer le tout sur le serveur, invoquez la commande suivante :

svn ci

plus classe : svn ci --message "message de commit qui apparaîtra dans le changelog"

Pour les répertoires, nous aurions procédé de la même façon

svn add directory

puis:

svn ci

Delete a file

Pour supprimer un fichier présent dans le repository, tapez simplement

svn rm file

puis envoyez vos modifications sur le serveur

svn ci


Update the repository

Quand on travaille en groupe, il peut être utile de pouvoir mettre à jour son dépot subversion. Pour cela, il suffit d'invoquer la commande suivante à la base du repository

svn up

Using Subversion as anonymous

Il est possible d'utiliser Subversion en anonyme. Cependant, vous n'aurez pas le droit de modifier le repository (suppression ou modification de fichiers). Pour faire un 'checkout' du repository, invoquez la commande suivante :

svn co svn://svn.tuxfamily.org/svnroot/VOTREPROJET/NOMDUREPOSITORY

Il est également possible de mettre à jour le repository au fur et à mesure que les développeurs mettent à jour le code via un simple

svn up

Attention cependant, le mode anonyme n'est disponible que si votre repository est mis en public (réglage par défaut)

Using the web interface

Vous pouvez consulter les repositories par le web à l'adresse suivante : http://svn.tuxfamily.org Les URLs sont de la forme http://svn.tuxfamily.org/groupe/dépôt/ ( http://svn.tuxfamily.org/vhffs4/vhffs/ par exemple )

Pour ceux qui préfèrent svnweb, ils peuvent être comblés à l'adresse http://svnweb.tuxfamily.org Les dépôts sont présentés sous la forme groupe/dépot. Vu que svnweb est heuuu... pas génial à coté de viewvc il n'est plus maintenu et voué à disparaitre. Il est encore présent car certains utilisent les flux RSS pour suivre les développements (comprendre que le jour ou cela sera intégré à VHFFS il disparaitra).

Using CIA

CIA est un système de commits, visitez le site pour de plus amples informations le concernant. Pour ajouter le support de CIA à votre repository TuxFamily, créez un compte utilisateur sur leur site. Puis, créez un projet, nommez-le comme bon vous semble, dans la partie configuration vous devriez voir un onglet "repository", allez dessus. Il vous faut alors cocher la case "Connect to a public Subversion repository", et remplir les champs qui apparaitront à vos yeux de la manière suivante :

Repository URL: svn://svn.tuxfamily.org/svnroot/votre_groupe/votre_repo

Vérifiez que la case du "polling" est bien cochée. Le délai de 15 minutes n'a pas besoin d'être changé. Et TuxFamily préfèrerait qu'il ne le soit pas pour éviter de trop nombreuses requêtes sur ses serveurs.

Obtenir des nouvelles régulières sur votre repository

Il est possible d'avoir des informations régulières à propos de votre repository. Il suffit pour cela d'utiliser le feed RSS placé sur le svnweb de votre repository. Par exemple, pour avoir les news régulières du repository REPO appartenant au groupe GROUPE, utilisez le fichier XML suivant : http://svnweb.tuxfamily.org/rss.php?repname=REPO+%28GROUPE%29&path=%2F&rev=0&sc=0&isdir=1

Chaque repository dispose d'un feed RSS, il vous suffit donc de l'utiliser.

Using a graphical interface

eSVN

Si vous êtes allergiques à la ligne de commande pourtant fort pratique, vous pouvez utiliser eSVN jusqu'à ce que le support de svn soit correctement opérationnel dans cervisia (qui vous sert peut-être déjà pour cvs).

Si vous utilisez la plateforme de developpement [Eclipse], il est possible d'utiliser subclipse un greffon disponible sur http://subclipse.tigris.org/

Peut-être y-aura-t-il tortoiseSVN disponible pour GNU/Linux un jour ? Pour windows, voici quelques tutoriels permettant de configurer l'utilisation d'une clé SSH avec tortoisePlink (version adaptée à tortoiseSVN de l'outil plink.exe en ligne de commande du célèbre putty)

- http://www.logemann.org/day/archives/000099.html
- http://tortoisesvn.sourceforge.net/docs/release/TortoiseSVN_en/ch05s25.html

TortoiseSVN

Pour utiliser SVN sous Windows, il existe le logiciel TortoiseSVN disponible sur http://tortoisesvn.net/downloads. Une traduction en français est disponible sur http://tortoisesvn.net/supported_languages . Pour le configurer en SSH, regarder la description de la configuration de session SSH située ci dessous.

Configuring Eclipse

Pour ajouter le support de [subversion] à [Eclipse] il faut installer le plug-in [SubClipse]. Pour installer ""SubClipse"" voir sur ce site http://www.think-underground.com/index.php/2006/01/30/162-monter-un-serveur-svn-subversion-et-y-acceder-depuis-eclipse. Par défaut ""SubClipse"" n'est pas paramétré pour gérer la connexion ssh. Pour l'activer, il faut lancer Eclipse, aller dans le menu "Window / Preference". Dans la liste, dérouler "Team" puis choisir "SVN". Dans la partie droite "SVN Interface", sélectionner ""JavaSVN (PureJava)"" au lieu de ""JavaHL (JNI)"". Maintenant vous pouvez reparamétrer la connexion au svn en utilisant

svn+ssh://VOTREUSER@svn.tuxfamily.org/svnroot/VOTREPROJET/NOMDUREPOSITORY

Upload your SSH public-key

Configuring SSH under GNU/Linux

Vous devez tout d'abord générer votre clef ssh, pour ce faire, ouvrez une console et tapez :

$ ssh-keygen -t rsa

Une "passphrase" vous sera demandée. Une fois entrée, votre clef ssh est prète a être utilisée. Avant tout, il faut créer un fichier nommé "ssh_keys" qui contiendra le contenu de la clef publique générée. Faisons ainsi:

$ cat ~/.ssh/id_rsa.pub >> ~/ssh_keys
$ chmod 700 ~/ssh_keys

Il faut maintenant les envoyer sur le serveur distant, en l'occurrence votre FTP Tuxfamily. Ouvrez un client FTP et allez sur votre compte, vous allez voir vos différents projets en cours, c'est à dire vos espaces Web. Restez a la base et copiez le fichier ssh_keys à l'intérieur.


Uploading your public-key

Il est possible de déposer votre clé SSH (publique) sur les serveurs de Tuxfamily. Cela vous permet de ne pas taper votre mot de passe à chaque opération effectuée sur le serveur Subversion.

  • Pour la déposer, il faut copier le contenu de votre clé publique dans le fichier ssh_keys (le créer si besoin) qui est placé dans votre répertoire de départ (répertoire home). Ce répertoire home est celui sur lequel vous arrivez lorsque vous vous identifiez sur le serveur FTP.
  • Ce fichier doit être placé et avoir un chmod de 700 (faire le chmod 700 à l'aide du client ftp).

Autrement dit, seul VOUS, utilisateur, avez le droit de lire, d'écrire et d'exécuter ce fichier.

Votre clé publique ssh est dans ~/.ssh/id_rsa.pub ou id_dsa.pub (si vous avez retenu un mode faiblard d'encryption), c'est ce fichier que vous mettez en ligne sous le nom ssh_keys.

Usage

Désormais il ne reste plus qu'à lancer une session SSH sur votre machine. Ceci se résume en 2 commandes. Tout d'abord (au cas où) il faut "killer" tous les processus ssh-agent si vous en avez lancé un. Sachez qu'il faut toujours verifier que aucun autre agent ssh soit lancé car Gnome et d'autres environnements lancent un agent.

$killall ssh-agent

Puis nous allons lancer les 2 commandes qui vont permettre à votre machine de communiquer avec SVN via SSH.

$ ssh-agent $SHELL
$ ssh-add ~/.ssh/id_rsa

Si tout s'est bien passé, vous n'aurez pas à taper votre mot de passe à chaque commande SVN que vous ferez par la suite. A chaque fois que vous voudrez utiliser cvs, il faudra ouvrir une session SSH:

$ ssh-agent $SHELL
$ ssh-add  ~/.ssh/id_rsa

Et toute les commandes SVN devront être tapées dans le même SHELL.

Pour éviter de devoir ouvrir une session à la main à chaque session, ajoutez ces lignes dans le fichier .bashrc :

if [ -f .ssh-agent ]; then
.ssh-agent
else
killall ssh-agent
ssh-agent > .ssh-agent
ssh-add ~/.ssh/id_rsa
fi

Note : Vous pouvez utiliser KeyChain http://www.gentoo.org/proj/en/keychain pour garder en mémoire votre passphrase et le ssh-agent.

IMPORTANT: Notez bien votre passphrase, elle vous sera demandée lors du login de votre bash.

Using SSH under proprietary MS Windows with TortoiseSVN

Commencer par recuperer les logiciels "Putty", "Plink", "Pageant" and "Puttygen" sur le site http://www.chiark.greenend.org.uk/~sgtatham/putty/

Lancer Puttygen, cliquez sur generer, puis bouger votre souris dans le carre vide(pendant 5 à 6 sec). Quoi de plus aleatoire?? Entrer la key Passphrase. Cela permet de proteger la cle. Enregistrer votre cle privé grace au bouton "save Private Key". Mettez ca en lieu sur (pour ne pas la perdre et que personne ne la recopie). Copiez ensuite la cle publique situé en haut de la fenetre. Collez la dans un fichier que vous nommerez "ssh_keys". Grace à un client FTP copiez le fichier "ssh_keys" à la racine du ftp de votre compte (acces par ftp.tuxfamily.org, login: celui de votre compte, mdp: celui de votre compte). Mettez l'acces pour que seul vous puissiez y acceder (en lecture, ecriture, execution)(chmod 700).

lancer Putty et configurer le comme suit:

Session->HostName: svn.tuxfamily.org

Session->Protocol: SSH

Session->Saved Sessions: Ce que vous voulez(par exemple tuxfamily)

SSH->Prefered SSH Protocol version: 2

SSH->Auth->Private Key file for auth: entrer l'emplacement et le nom de votre fichier ou est stocke votre cle privé.


Dans le menu Session, cliquer sur "Save" afin d'enregistrer la configuration. Cliquez sur Open. Si une fenetre apparait puis se ferme c'est bon. Sinon c'est qu'il y a un probleme.

Configuring TortoiseSVN

Pour mettre des fichiers sur le serveur SVN, créer votre arborescence avec vos fichiers sur votre PC puis cliquer droit sur le dossier contenant votre arborescence puis cliquer sur Exporter (si TortoiseSVN est en francais sinon CheckOut) Entrer l'adresse : svn+ssh://login_tuxfamily@NomQueVousAvezChoisiDansPutty(SavedSessions)/svnroot/NomDuGroupe/NomDuDepotSVN . Bien sûr, remplacer les champs par ceux correspondant. Votre arborescence devrait être sur votre serveur. Si vous voulez récuperer des fichiers du serveur, cliquer sur Extraire (à la place de exporter) dans un répertoire vide.

Par la suite, pour mettre des fichiers sur votre serveur, cliquer sur Livrer (ou Commit). Pour mettre à jour la version sur votre PC, utiliser la fonction Mettre à jour (ou Update) du menu Tortoise.

Using Pageant to remember the passphrase of your SSH key

Lancez Pageant, récupéré préalablement comme indiqué ci-dessus. Celui-ci se charge, et une icône est rajoutée dans la barre des tâches. Double-cliquez dessus pour ouvrir la fenetre principale de Pageant. Cliquez sur le bouton "Add Key" et sélectionnez le fichier de la clef privé ("votre_fichier.ppk"). Pageant vous demande alors la passphrase de la clef. Une fois la passphrase entrée, vous pouvez effectuer vos connections sans avoir à retaper à chaque fois la passphrase.

Note importante : Cette opération est à refaire après chaque redémarrage de Pageant, si vous cliquez sur Exit, par exemple, dans le menu contextuel de l'icone de la barre des tâches, ou si vous redémarrez votre machine. Vous pouvez automatiser cette procédure au démarrage de votre machine en créant un raccourci dans votre dossier démarrage, en mettant cette ligne de commande :

"E:\Program Files\PuTTY\pageant.exe" "X:\mon_chemin\ma_clef.ppk"

Vous n'aurez ainsi qu'à taper la passphrase au démarrage de Windows dans la petite boite de dialogue qui vous attendra bien gentillement!

Collaborative developements, writing permissions

Tous les utilisateurs du groupe auront la permission d'écrire sur le SVN. Autrement dit, si vous désirez développer à plusieurs sur un même repository, il est conseillé d'ajouter les développeurs au groupe via le panel. Toutefois, il faut que les développeurs se créent un compte sur le panel au préalable.

Un projet correspond à un groupe (au sens Unix du terme), il faut ajouter vos co-développeurs à votre projet pour qu'ils puissent commiter des modifications au dépôt subversion (ils auront aussi accès à l'arborescence, permettant de maintenir l'intégralité du projet collaborativement).

Autrement, vous risquez d'obtenir le message suivant :

Transmission des données .svn: Échec de la propagation (commit), détails : 
svn: Can't create directory '/svnroot/votreprojet/votrerepository/db/transactions/7-1.txn': Permission denied

Miscellaneous

  • Il est conseillé de ne commiter que des éléments qui compilent correctement (mais qui ne fonctionnent pas forcément) afin que le trunk puisse être testé n'importe quand par de nouveaux utilisateurs.
  • Vous devez choisir les fichiers à versionner, il n'est pas exemple pas nécessaire d'archiver des fichiers de backup (faites attention aux éditeurs qui créent des copies en xxx~, ces copies ne doivent pas être versionnées) ni les fichiers issus directement de la compilation des sources. Pour cela, subversion propose la propriété svn:ignore (http://svnbook.red-bean.com/nightly/en/svn-book.html#svn.advanced.props).
  • Evitez de prendre un nom générique comme "svn" ou "subversion". Utilisez plutot un nom en rapport avec votre projet ou même, prenez le nom de votre projet ...

Useful links