Differences between revisions 1 and 84 (spanning 83 versions)
Revision 1 as of 2008-05-16 04:06:25
Size: 2655
Editor: ?AndresMejia
Comment: Started VCS page for repositories used by the games team
Revision 84 as of 2009-11-08 04:23:42
Size: 5101
Editor: ?kgoetz
Comment: an indicator of svn checkout size
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
== Git ==
The repositories for the packaging in git is stored in a different manner than they are under svn. Each package has it's own git repository (and thus it's own directory) under the /git/pkg-games directory on the alioth servers.
#language en
<<TableOfContents>>
Line 4: Line 4:
This guide assumes that you are uploading the packaging files for a package for the first time. The Debian Games Team currently uses either git or svn to help in maintaining packages. This page will help you get started in using either git or svn repositories.
Line 6: Line 6:
A separate section will describe how to import the packaging that was stored in the svn repository in the future. == Scheme ==
Line 8: Line 8:
=== Creating a git repository ===
First, create a repository in the /git/pkg-games directory on the alioth servers.
Most of the packages are independent from each other. In svn, a [trunk,tags,branches}/<package> scheme is used with only the debian directory stored. The .orig.tar.gz files in such a case are stored in /var/lib/gforge/chroot/home/groups/pkg-games/htdocs/tarballs in the alioth servers. They can be accessed online at [[http://pkg-games.alioth.debian.org/tarballs]]. In git, each package has it's own repository. The contents of the orig tarball are stored directly within each package's repository, inside the 'upstream' branch. The {{{pristine-tar}}} program can be used to regenerate an orig tarball from the upstream branch.

== Setting up ==
The first thing to do is get an account on alioth.debian.org. Visit the following link.
 . http://alioth.debian.org/account/register.php

The next step is to join the team. Visit the Alioth page for the team and click on "request to join".
 . https://alioth.debian.org/projects/pkg-games/ [[https://alioth.debian.org/project/request.php?group_id=30862|direct link]]

Next, you will need an ssh key for each computer you plan on working on packages with. If you don't have a key on a particular system, create one.
Line 11: Line 19:
$ mkdir <package>.git
$ cd <package>.git
$ git --bare init --shared
$ ssh-keygen
Line 16: Line 22:
Now edit the 'description' file in the directory you just created to one that is appropriate for the package. This should have created an RSA key for SSH protocol 2 by default. Upload the contents of your public keys ({{{~/.ssh/id_rsa.pub}}}) to your account in Alioth. To do this, copy the contents of each public key for your machines and paste them at the following link.
 . https://alioth.debian.org/account/editsshkeys.php

Next, create an SSH configuration file ({{{~/.ssh/config}}}) for your user profile to work with the alioth servers. Here's how to do the following in a terminal session.
Line 18: Line 27:
$ echo "Packaging for <package>" >description $ cat >>~/.ssh/config <<EOF
Host svn.debian.org
        User <username>

Host git.debian.org
        User <username>

Host alioth.debian.org
        User <username>
EOF
Line 21: Line 39:
Let's also enable the use of 'hooks/post-update'. Now you should be able to logon from each of your machines by doing the following.
Line 23: Line 41:
$ chmod a+x hooks/post-update $ ssh svn.debian.org
$ ssh git.debian.org
$ ssh alioth.debian.org
}}}
Note: There's usually a one hour delay when uploading your ssh public keys. During this delay, you can still login with your password.

== mr ==

The mr command can be used to checkout, update, and commit to multiple repositories. In the pkg-games svn repository, is a packages/trunk/mrconfig/.mrconfig file that configures mr for all the repositories used by the games team.

New git repositories should be added to this .mrconfig file.

To use it, install the mr package, and create a ~/.mrconfig file letting mr know about the pkg-games svn repository. In this example, it will be checked out to ~/src/packages/games, but you can modify to suit. If you already have a pkg-games svn checkout, you can change the directory to point to that. Note that the last field on the 'checkout' line ('games' in this instance) should match the last field of the configuration path ('src/packages/games').

{{{
[src/packages/games]
chain = true
checkout = svn co svn+ssh://svn.debian.org/svn/pkg-games/packages/trunk games
Line 26: Line 61:
Now we're done creating a repository for the package. You could also use the 'setup-repository' script that's in the pkg-games directory. That script is really a symlink to the script that's used in the collab-maint directory. Then run "mr checkout", which will checkout the svn repository into ~/src/packages/games. The checkout will be approximately 120MB.

A second "mr checkout" (necessary because of bug #447553) will checkout the additional git repositories, into subdirectories of ~/src/packages/games/.

Now you can use mr to act on all configured repositories at once.

Update all repositories:
Line 28: Line 70:
./setup-repository <package> '<package description>' % mr update
Line 31: Line 73:
=== Uploading a package to the repository ===
Now let's import the package into a git repository. This is easy using 'git-import-dsc' from the 'git-buildpackage' package.
Get status of all checkouts:
Line 34: Line 76:
$ git-import-dsc <package>.dsc % mr status
Line 37: Line 79:
A directory with the name of the source package should have been made. Change into that directory. List all repositories that mr knows about:
Line 39: Line 82:
$ cd <package> % mr list
Line 42: Line 85:
Ensure the tags that are created reflect if a package has been released. git-buildpackage creates tags for the debian branch and the upstream branch. If the tag created for the debian branch reflects an unreleased version, you'll have to delete that "debian" tag. Or even commit changes in each repository:
Line 44: Line 88:
$ git-tag -l
$ git-tag -d 'debian/<unreleased version>'
% mr commit
Line 48: Line 91:
Finally, push the repository up to the repository on alioth.
{{{
$ git-remote add alioth git+ssh://<username>@git.debian.org/git/pkg-games/<package>.git
$ git-push alioth master
$ git-push alioth upstream
$ git-push alioth --tags
}}}
If you've added a new git repository in ~/src/packages/games/<foo> and are in that directory, you can have mr automatically add it to the pkg-games .mrconfig file by running "mr register". (Don't forget to commit the file.)
Line 56: Line 93:
=== Accessing a repository ===
To get a repository, do the following.
{{{
$ git-clone git+ssh://<username>@git.debian.org/git/pkg-games/<package>.git
}}}
== Git ==
Line 62: Line 95:
You can also enjoy read-only access by using the following.
{{{
$ git-clone git://git.debian.org/git/pkg-games/<package>.git
$ git-clone http://git.debian.org/git/pkg-games/<package>.git
}}}
See [[Games/VCS/git]].
Line 68: Line 97:
To view a summary of the repository on your favorite web browser, go to the following address.
{{{
http://git.debian.org/?p=pkg-games/<package>.git
}}}
== SVN ==

See [[Games/VCS/svn]].

== General Rules ==
 * If a package you're working on is for a particular version that has not been uploaded to the archive, you should either append {{{~unrelease0}}} at the end of the version, or use 'UNRELEASED' as the suite in the changelog.
 * packages/ in the svn repo is for free games only. For games which should go to non-free, please use non-free/package/.
 * the SVN properties of the debian/ directory should point to the location where the orig.tar.gz file(s) can be fetched.

== See Also ==
 * [[Alioth/Git]]
 * http://www.kernel.org/pub/software/scm/git/docs/ - git Documentation
 * [[SmallSVNTutorial]]
 * [[Alioth/Svn]]
 * http://svnbook.red-bean.com/ - Subversion Documentation
 * [[http://www.hmug.org/man/5/ssh_config.php|ssh_config man page]] - Manual on OpenSSH SSH client configuration files
 * [[http://git.or.cz/gitwiki/GitCheatSheet]] - Git Cheat

The Debian Games Team currently uses either git or svn to help in maintaining packages. This page will help you get started in using either git or svn repositories.

Scheme

Most of the packages are independent from each other. In svn, a [trunk,tags,branches}/<package> scheme is used with only the debian directory stored. The .orig.tar.gz files in such a case are stored in /var/lib/gforge/chroot/home/groups/pkg-games/htdocs/tarballs in the alioth servers. They can be accessed online at http://pkg-games.alioth.debian.org/tarballs. In git, each package has it's own repository. The contents of the orig tarball are stored directly within each package's repository, inside the 'upstream' branch. The pristine-tar program can be used to regenerate an orig tarball from the upstream branch.

Setting up

The first thing to do is get an account on alioth.debian.org. Visit the following link.

The next step is to join the team. Visit the Alioth page for the team and click on "request to join".

Next, you will need an ssh key for each computer you plan on working on packages with. If you don't have a key on a particular system, create one.

$ ssh-keygen

This should have created an RSA key for SSH protocol 2 by default. Upload the contents of your public keys (~/.ssh/id_rsa.pub) to your account in Alioth. To do this, copy the contents of each public key for your machines and paste them at the following link.

Next, create an SSH configuration file (~/.ssh/config) for your user profile to work with the alioth servers. Here's how to do the following in a terminal session.

$ cat >>~/.ssh/config <<EOF
Host svn.debian.org
        User <username>

Host git.debian.org
        User <username>

Host alioth.debian.org
        User <username>
EOF

Now you should be able to logon from each of your machines by doing the following.

$ ssh svn.debian.org
$ ssh git.debian.org
$ ssh alioth.debian.org

Note: There's usually a one hour delay when uploading your ssh public keys. During this delay, you can still login with your password.

mr

The mr command can be used to checkout, update, and commit to multiple repositories. In the pkg-games svn repository, is a packages/trunk/mrconfig/.mrconfig file that configures mr for all the repositories used by the games team.

New git repositories should be added to this .mrconfig file.

To use it, install the mr package, and create a ~/.mrconfig file letting mr know about the pkg-games svn repository. In this example, it will be checked out to ~/src/packages/games, but you can modify to suit. If you already have a pkg-games svn checkout, you can change the directory to point to that. Note that the last field on the 'checkout' line ('games' in this instance) should match the last field of the configuration path ('src/packages/games').

[src/packages/games]
chain = true
checkout = svn co svn+ssh://svn.debian.org/svn/pkg-games/packages/trunk games

Then run "mr checkout", which will checkout the svn repository into ~/src/packages/games. The checkout will be approximately 120MB.

A second "mr checkout" (necessary because of bug #447553) will checkout the additional git repositories, into subdirectories of ~/src/packages/games/.

Now you can use mr to act on all configured repositories at once.

Update all repositories:

% mr update

Get status of all checkouts:

% mr status

List all repositories that mr knows about:

% mr list

Or even commit changes in each repository:

% mr commit

If you've added a new git repository in ~/src/packages/games/<foo> and are in that directory, you can have mr automatically add it to the pkg-games .mrconfig file by running "mr register". (Don't forget to commit the file.)

Git

See Games/VCS/git.

SVN

See Games/VCS/svn.

General Rules

  • If a package you're working on is for a particular version that has not been uploaded to the archive, you should either append ~unrelease0 at the end of the version, or use 'UNRELEASED' as the suite in the changelog.

  • packages/ in the svn repo is for free games only. For games which should go to non-free, please use non-free/package/.
  • the SVN properties of the debian/ directory should point to the location where the orig.tar.gz file(s) can be fetched.

See Also