Factor/Contributing/Git Repository Setup

Where to get Git space

See the FAQ.

Contact Daniel Ehrenberg (microdan@gmail.com) to get an account on http://factorforge.org. Even the most trivial contributions get space here! Ask him for further directions if the ones below are insufficient.

  • factorforge.org appears down (2009-07-12). or not yet created?

How to publish a Git repository

To set up a repository on a server you should clone the existing Factor repository using the '--bare' option:

git clone --bare git://factorcode.org/git/factor.git factor.git

A bare repository is one without a checked out working copy of the code. It only contains the git database. As a general rule you should never push into a repository that contains changes in the working copy. To ensure this doesn't happen, we're making the server repository a bare repository - it has no working copy.

Copy the 'factor.git' directory onto your server. I put it in '/git/factor.git'. Now if you have changes on your local machine that you want to push to your repository you can use something like:

git push yourname@yourserver.com:/git/factor.git

If you want to push changes from a specific branch in your local repository:

git push yourname@yourserver.com:/git/factor.git mybranch:master

To publish the remote repository you have two options. You can publish via the HTTP protocol, or via the git protocol. The first is slower but usable by people behind restrictive firewalls, while the second is more efficient but requires an open port. I suggest doing both.

To publish via HTTP, you must make the file 'hooks/post-update' executable:

chmod +x /git/factor.git/hooks/post-update

This gets executed whenever something is pushed to the repository. It runs a command 'git-update-server-info' which updates some files that makes the HTTP retrieval work. You should also run this once manually:

cd /git/factor.git

Now make the /git directory published via your webserver (symbolic link to it in the server's doc-root). People can pull from the repository with:

git pull http://yourserver.com/git/factor.git

To set up the git protocol you need to run the 'git-daemon' command. You pass it a directory which is the root of your git repositories. It will make public all git repositories underneath that root that have the file 'git-daemon-export-ok' in it. So first create this file:

touch /git/factor.git/git-daemon-export-ok

Run the daemon with:

git-daemon --verbose /git

The '--verbose' will give you output showing the results of connecting to it. You can set it up to automatically run using whatever features your server OS has. Now people can retrieve via the git protocol:

git pull git://yourserver.com/git/factor.git

factorcode.org's repository is accessible from both protocols:

git clone http://factorcode.org/git/factor.git
git clone git://factorcode.org/git/factor.git

You can also browse it using gitweb.

Article originally from Chris Double at http://www.bluishcoder.co.nz/2007/09/how-to-publish-git-repository.html

This revision created on Sun, 12 Jul 2009 19:07:55 by mncharity (+link to FAQ)