The Maintainers' Corner

This page aims at regrouping all the informations, tips, links, etc. that are useful for maintainers.

Branches

The "master" branch (what you get when you do a simple git clone) is used for development of the unstable branch, with maintenance of the stable branch on a git branch. The stable branch is usually created just before the unstable branch is declared stable, because that is when some people start working on the next unstable development phase.

We try to use the same git branch names for all GNOME modules. For instance, gnome-2-14 would be an excellent choice for a branch name targetting the GNOME 2.14 release, according to these rules:

When a stable branch is made for a GNOME release, release-team, gnome-doc-list, and gnome-i18n must be notified. If you use the standard branch name format, this will happen automatically. If you have your @gnome.org email alias set up, you will receive a copy of this notification. Otherwise, please check the archives to ensure a branch notification email was sent. Send a notification email to these manually if no automatic email is sent.

If appropriate, also update the jhbuild moduleset with the appropriate revision. e.g. your module's <branch/> tag for gnome-2-20 would become <branch revision="gnome-2-20"/>.

For historical interest, you can read more about this in the branching GEP.

Example

Here's an example, when branching for 2.14 (inside a clone of the module!):

git branch gnome-2-14 master
git push origin gnome-2-14
git branch -d gnome-2-14
git checkout -b gnome-2-14 origin/gnome-2-14

where origin is the local name for the GNOME Git repository. The last two commands is to ensure that your local branch is properly setup to track the remote branch.

If you forgot branching and want to use an older commit for branching, for example to have the last 3 commits in master not included in your new gnome-2-14 branch, use "HEAD~x" (where x stands for the number of latest commits to exclude from your new branch) instead of "master":

git branch gnome-2-14 HEAD~3
git push origin gnome-2-14

A shorter way to create a new remote branch & track it within a local branch is (using a fully qualified ref spec):

git push origin origin:refs/heads/gnome-2-14
git checkout -b gnome-2-14 origin/gnome-2-14

To delete a faulty remote branch use:

#potentially dangerous!
git push origin :gnome-2-14

If unsure use the --dry-run option for git-push first.

I'm a new maintainer, what should I do?

Here are some things you should do when you're becoming maintainer for a module:

Creating/importing a new module in GNOME git

To create or import a new module, see Git/NewRepository.

Here's a small list of other important steps to do when creating or importing a new module in git:

Is a MAINTAINERS file still needed?

No, please create [module].doap files instead.

What should a [module].doap file look like?

See Git/FAQ


CategoryJhbuild

MaintainersCorner (last edited 2017-09-27 14:38:18 by AndreKlapper)