Hosted repository setup

From FedoraProject

Revision as of 16:33, 18 September 2010 by Codeblock (Talk | contribs)

Jump to: navigation, search
Infrastructure InfrastructureTeamN1.png


Fedora hosted has public repositories for git, bazaar, mercurial, and subversion. These are instructions for adding a new project to one of them.

Note.png
Monotone support has been discontinued due to both lack of a sysadmin to maintain it and lack of projects wanting to use it.

Contents

Mercurial Repository

You'll need to know three things in order to start the mercurial repository.

  1. PROJECTNAME -- what the project wants to be called.
  2. OLDURL -- how to access the project's current sourcecode in their mercurial repository.
  3. PROJECTGROUP -- the group setup in the account system for readwrite access to the repository.

The Mercurial repository lives on the hosted server. Access it by logging into hosted1 Then follow these steps:

$ cd /hg
$ sudo hg clone -U $OLDURL $PROJECTNAME (or sudo mkdir $PROJECTNAME; cd $PROJECTNAME; sudo hg init)
$ sudo find $PROJECTNAME -type d -exec chmod g+s \{\} \;
$ sudo chmod -R g+w $PROJECTNAME
$ sudo chown -R root:$PROJECTGROUP $PROJECTNAME

This should setup all the files needed for the repository.

Commit Mail

The Mercurial Notify extension can be used to send out email when commits are pushed to a Mecurial repository. To enable notifications, create the file /hg/$PROJECTNAME/.hg/hgrc:

[extensions] 
hgext.notify =

[hooks] 
changegroup.notify = python:hgext.notify.hook

[email] 
from = admin@fedoraproject.org

[smtp] 
host = localhost

[web] 
baseurl = http://hg.fedorahosted.org/hg

[notify] 
sources = serve push pull bundle
test = False
config = /hg/$PROJECTNAME/.hg/subscriptions
maxdiff = -1

And the file /hg/$PROJECTNAME/.hg/subscriptions:

[usersubs] 

user@host = *

[reposubs] 

Git Repository

You'll need to know several things in order to start the git repository.

  1. PROJECTNAME -- what the project wants to be called.
  2. OLDURL -- how to access the project's current source code in their git repository.
  3. PROJECTGROUP -- the group setup in the account system for write access to the repository.
  4. COMMITLIST -- comma-separated list of email addresses for commits (optional)
  5. DESCRIPTION -- description of the project (optional)
  6. PROJECTOWNER -- the FAS username of the project owner

The git repository lives on the hosted server. Access it by logging into hosted1 Then follow these steps:

$ cd /git

$ # Clone an existing repository:
$ sudo git clone --bare $OLDURL $PROJECTNAME.git
$ cd $PROJECTNAME.git
$ sudo git config core.sharedRepository true
$ #
$ ## or
$ #
$ # Create a new repository:
$ sudo mkdir $PROJECTNAME.git
$ cd $PROJECTNAME.git
$ sudo git --bare init --shared=true

$ # Give the repository a nice description for gitweb
$ echo $DESCRIPTION | sudo tee description > /dev/null

$ # Setup and run post-update hook.
$ # (We symlink this because /git is on a filesystem with noexec set)
$ sudo ln -svf $(git --exec-path)/git-update-server-info ./hooks/post-update
$ sudo git update-server-info

$ # Ensure ownership and modes are correct
$ sudo find -type d -exec chmod g+s \{\} \;
$ sudo find -perm /u+w -a ! -perm /g+w -exec chmod g+w \{\} \;
$ sudo chown -R $PROJECTOWNER:$PROJECTGROUP .

This should setup all the files needed for the repository. The repository owner can push changes into the repo by running:

$ git push ssh://git.fedorahosted.org/git/$PROJECTNAME.git/ master

from within their local git repository.

Commit Mail

If they want commit mail, then there are a couple of additional steps.

$ echo $COMMITLIST | sudo tee $PROJECTNAME.git/commit-list > /dev/null
$ sudo ln -svf /usr/bin/fedora-git-commit-mail-hook $PROJECTNAME.git/hooks/update

CIAbot Notifications

The CIA bots can be used to send git commit messages to IRC channels. See http://cia.vc/ for information.

To have IRC messages sent whenever you publish new commits to your git repository, you can add a git update hook.

In your home directory on fedorahosted, create two files: a copy of ciabot.pl modified with your own project name and email address; and an 'update' file, modified to include the path to your copy of the ciabot.pl script.

$ cd
$ mkdir $PROJECTNAME-hooks
$ cat - > $PROJECTNAME-hooks/update << EOF
refname=${1#refs/heads/}
[ "$refname" = "master" ] && refname=
oldhead=$2
newhead=$3
for merged in $(git-rev-list $newhead ^$oldhead | tac); do
    /home/fedora/$PROJECTOWNER/$PROJECTNAME-hooks/ciabot.pl $merged $refname
done
EOF
$ chmod a+x $PROJECTNAME-hooks/update
$ cd /git/$PROJECTNAME/hooks
$ mv update update.orig
$ ln -s /home/fedora/$PROJECTOWNER/$PROJECTNAME-hooks/update

These must be in your home directory, as the git repositories themselves are mounted using 'noexec'.

Bazaar Repository

You'll need to know three things in order to start a bazaar repository.

  1. PROJECTNAME -- what the project wants to be called.
  2. OLDBRANCHURL -- how to access the project's current sourcecode in their previous bazaar repository. Note that a project may have multiple branches that they want to import. Each branch will have a separate URL. (The project can import the new branches after the repository is created if they want.)
  3. PROJECTGROUP -- the group setup in the account system for readwrite access to the repository.

The bzr repository lives on the hosted server. Access it by logging into hosted1 then follow these steps:

The first stage is to create the Bazaar repository.

$ cd /srv/bzr/
$ # This creates a Bazaar repository which has shared storage between branches
$ sudo bzr init-repo $PROJECTNAME --no-trees
$ cd $PROJECTNAME
$ sudo bzr branch $OLDURL
$ sudo bzr branch $OLDURL2
$ # [...] 
$ sudo bzr branch $OLDURLN
$ cd ..
$ sudo find $PROJECTNAME -type d -exec chmod g+s \{\} \;
$ sudo chmod -R g+w $PROJECTNAME
$ sudo chown -R root:$PROJECTGROUP $PROJECTNAME

This should be all that is needed. To checkout run:

bzr init-repo $MYLOCALPROJECTREPO
cd $MYLOCALPROJECTREPO
bzr branch bzr+ssh://bzr.fedorahosted.org/bzr/$PROJECTNAME/$BRANCHNAME
bzr branch bzr://bzr.fedorahosted.org/bzr/$PROJECTNAME/$BRANCHNAME/

Note: If the end user checks out a branch without creating their own repository they will need to create a local working tree by doing the following:

cd $BRANCHNAME
bzr checkout --lightweight

SVN Repository

You'll need to know two things in order to start a svn repository.

  1. PROJECTNAME -- what the project wants to be called.
  2. PROJECTGROUP -- The Fedora account system group with read-write access.
  3. COMMITLIST -- comma-separated list of email addresses for commits (optional)

SVN lives on the hosted server. Access it by logging into hosted1. Then run the following steps:

$ cd /svn/
$ sudo svnadmin create $PROJECTNAME
$ sudo chgrp -R $PROJECTGROUP $PROJECTNAME
$ sudo chmod -R g+w $PROJECTNAME
$ find $PROJECTNAME -type d | sudo xargs chmod g+s

This should be all that is needed. To checkout run:

svn co svn+ssh://svn.fedorahosted.org/svn/$PROJECTNAME

Commit Mail

If they want commit mail, then there are a couple of additional steps.

$ echo $COMMITLIST | sudo tee $PROJECTNAME/commit-list > /dev/null
$ sudo ln -sv /usr/bin/fedora-svn-commit-mail-hook $PROJECTNAME/hooks/post-commit