BzrMaintainerHowto

Revision 1 as of 2006-06-09 13:48:37

Clear message

How to maintain your package in bzr

This page sets out how to begin maintaining an Ubuntu source package using our bzr revision control system. If you want to work on a source package that is already maintained using bzr, see the BzrContributorHowto page instead.

Knowledge of how to use bzr is assumed to keep this simple to follow.

It's also assumed that you have a Launchpad account (after all, you're an Ubuntu maintainer) and that you've registered your SSH public keys there so you can use the SFTP "supermirror".

Registering your package

The most important thing to do first is to register the package so that other people can find your revision control branch. If people are not able to find the branch, they may not realise it is maintained in revision control in the first place, and may upload directly to the archive without making their changes available properly.

Register the product in Launchpad

Branches in Launchpad are registered against products, so you need to make sure there is a product ready for it. If this is a new native source, you'll probably have to register it.

Make sure other developers know about it

The BzrMaintainedPackages wiki page lists the packages being currently maintained in bzr. For each source package you should link to the /+branches page of the product so that the branches can be seen at a glance.

You should also send a mail to ubuntu-devel-announce@lists.ubuntu.com telling everyone that this package is now maintained with bzr.

Pushing the first version

When you're ready to push the first version up, this might be right after running bzr init or may be when you first upload, you need to make a decision about who else can work on it.

  • If the package is intended for main, then the team should be ubuntu-core-dev.

  • If the package is intended for universe, then the team should be ubuntu-dev.

Now push your branch onto the super-mirror using the following URL form:

  • sftp://$USER@bazaar.launchpad.net/~$TEAM/$PRODUCT/ubuntu

Where:

  • $USER is your launchpad user-id.

  • $TEAM is the team that will own the branch.

  • $PRODUCT is the launchpad name of the product you found or registered.

e.g.

  • sftp://kamion@bazaar.launchpad.net/~ubuntu-core-dev/ubiquity/ubuntu

Non-native packages?

What about packages that have an upstream. I suggest you use the following branch layout:

  • Import the upstream source into one branch.

  • Push this as /upstream

  • Branch this to apply the Ubuntu changes.

  • Push this as /ubuntu

When a new upstream release is out, simply import and commit that into the /upstream branch and merge from it.

Packages with patches?

And what about packages with multiple things in debian/patches? I suggest the following URL form /ubuntu.$PATCH for each patch.

A tool to make these easier will appear very shortly.

Debian-derived packages?

You can do these in the same way as non-native above, except import the Debian source using /debian and branch for /ubuntu.

Uploading

Uploading is just a matter of running dpkg-buildpackage as usual, but remembering to strip out the .bzr directories. I'd suggest just using pristine upstream tarballs rather than trying to generate them from the upstream branch.

Be sure to commit and push any debian/changelog changes you make.

Linking the Product and Source together

Once the first version has been uploaded, you should make sure that the product and source package are linked together in Launchpad. If you're importing a source package that already exists, you can do this at any time, e.g. when you locate or register the product.

  • Pick the appropriate Release Series of the product, freshly registered ones have a main/trunk series created automatically. If the product has multiple lines of development, and can be packaged multiple times, it may be appropriate to create one (e.g. a 2.16 series for GNOME packages)

  • From the Release Series package, click Link to Ubuntu Package in the portlet.

  • Enter the source package name.