Overview

Here's the quick run-down of what you need to do, to set up your daily builds.

• Have source code in launchpad (either use code.launchpad.net or have source import)
• Select branch used for daily build
• Write recipe
• Test build locally
• trigger builds via launchpadlib

Prerequisites

Code in Launchpad

Launchpad's Daily Builds only works on code that exists in Launchpad. Either you make use of Launchpad Code yourself (easier), or you set up Launchpad to import code from somewhere else.

Packaging

Somebody needs to have packaged your software before. If your software for example is in Ubuntu or Debian, you are sorted out. If there's another branch in Launchpad, that contains packaging for your software, you are sorted out. With the "recipe" (more on the topic below), you can sort-of-merge the packaging into your daily branch.

If you no Debian/Ubuntu packaging of your software exists, you might want to have a look at PackagingGuide/PackagingOverview to get your initial packaging set up.

Make sure that the build process in your packaging can deal with what's in your branch. For example, if you work on a C project with autotools, you might have to run autoreconf -i at some stage during the build to make sure that all the auto-generated files (which are not in version control) are present.

Recipe

"recipes" are descriptions of the steps needed to construct a package from the various bzr branches. It relies on a certain format that specifies

• where to use the code from (trunk branch, beta branch, etc.), where to get the packaging from (separate branch? ubuntu branch?)
• the correct package version (so users will still be able to upgrade to the stable version of the distro once it gets released)
• what to modify to make the source build properly

In this first step, just write it in a text editor. Later on, you'll test it locally, then enable it in Launchpad.

Writing it

The start of the file always looks similar to

# bzr-builder format 0.2 deb-version 1.0+{time}

The # bzr-builder format 0.2 is the same for each, and just specifies the version of the format in use. The current format is 0.2, and is increased as the format changes.

deb-version 1.0+{time} specifies the version to use for the generated package. {time} here is a substitution variable, more information on those will be given later.

The next line specifies the branch to base the package on:

lp:bzr

This says that we will use the trunk of the bzr project.

Then there is any number of other lines to specify other branches to include. The usual way to do this is to use the merge keyword to specify a simple merge of the branch.

merge fix-build lp:~bzr/bzr/fix-build

fix-build is the id of the branch within this file, it doesn't have to be the same as any part of the branch URL, but it has to be unique within the file. lp:~bzr/bzr/fix-build is again the location of the branch. What we are doing here is merging in a branch that we know we need in order to fix the build, but that hasn't landed in lp:bzr yet.

The other way to include code is to use the nest keyword.

nest pyfoo lp:pyfoo foo

The nest keyword specifies nesting another branch, instead of merging it. In this case we are nesting lp:pyfoo in to lp:bzr. We are using pyfoo to refer to it in the file, and we want it nested in the foo directory, so we specify that last.

It is possible to act on the nested branch in the same way as with the main branch. Any lines that are indented by two spaces under a nest line will act on the nested branch, e.g.

  merge branding lp:~bob/pyfoo/ubuntu-branding

would merge the ubuntu-branding branch in to foo.

The resulting branch needs to already have the debian directory in place with the packaging in it, as it can't be auto-generated. Therefore you will often need to merge one or more packaging branches:

merge packaging lp:~bzr/bzr/packaging

In total this recipe would look like

# bzr-builder format 0.2 deb-version 1.0+{time}
lp:bzr
merge fix-build lp:~bzr/bzr/fix-build
nest pyfoo lp:pyfoo foo
  merge branding lp:~bob/pyfoo/ubuntu-branding
merge packaging lp:~bzr/bzr/packaging

Specifying revisions

Sometimes you want to specify a specific revision of a branch to use, rather than the tip. You can do this by including a revision specifier at the end of any branch line, e.g.

merge packaging lp:~bzr/bzr/packaging revno:2355

or, for the first branch line

lp:bzr tag:1.0

would mean that every time the recipe was used it would use the "1.0" tag from that branch.

Version numbers

The deb-version specifier allow you to specify a version number for the resulting package, but it's not very useful if it is only ever a single version number, as you need it to increase.

The example above (1.0+{time}), use a substitution variable. This will be replaced when the version number is needed with the current date and time (UTC). This will ensure that later packages get higher version numbers.

There is a second variable that you can use as well: {revno}. This will be replaced with the revision number of the revision that was used from the primary branch. You can use the revision number of any branch by using {revno:<branch id>}.

You can use as many substitution variables as you like, e.g.

  deb-version 1.0+{revno}-0ubuntu0+{revno:packaging}+{time}

Which would expand to something like

  deb-version 1.0+4264-0ubuntu0+2145+200907201627

Other possible substitution variables are: revno, revno:packaging, tags, distroseries.

Testing locally

Testing the recipe

It's very important to test your recipe locally, else your build might fail in Launchpad over and over again without you noticing. Also might the package versioning be broken. Make sure you test locally first!

Save your recipe file to <project>.recipe.

• If you run Windows or Mac, check out how to run Ubuntu in a virtual machine for the test.

• If you want to test on a specific version, check out this documentation for how to do that in a safe and sane manner.

Once you're happy with the specific Ubuntu version you want to test this in, please install

• bzr-builder from the archive if available or

• from https://launchpad.net/~dailydebs-team/+archive/bzr-builder

In order to build the recipe you need to use the bzr dailydeb command.

$ bzr dailydeb package.recipe working-dir

This will perform the steps specified in <project>.recipe. It will create working-dir and put the resulting source tree and the source package there.

Testing the build

Now we have a source package. Now let's test the build process.

First we set up pbuilder, a tool that sets up a clean, minimal environment for the build, so we can be sure it builds everywhere.

1. sudo apt-get install pbuilder

2. edit ~/.pbuilderrc and add

   COMPONENTS="main universe multiverse restricted"

3. sudo pbuilder create

To kick off the test-build, run

sudo pbuilder build <working-dir>/<project>_<version>.dsc

If the build succeeds, you can test-install the resulting package from /var/cache/pbuilder/result/.

Setting up the recipe in Launchpad

Now that you confirmed the recipe to work, the rest is very simple.

Browse to the branch you want to build in Launchpad. Click on "(+) Create packaging recipe".

Now fill in all the necessary details:

• Name: simple name of the recipe. Remember: you might want more than one.

• Description: please make it clear what users of this build sign up for.

• Owner: select who drives these builds.

• Source Package Name: if the package exists in Ubuntu, make the right connection here.

• Default Distribution Series: select all the Ubuntu releases you want to build the package for. Make sure all these builds work before you sign up for them!

• Recipe text: paste your recipe in here.

Building

To trigger builds regularly, you can use this simple launchpadlib snippet:

   1 person = launchpad.people["person-who-owns-the-recipe"]
   2 recipe = person.getRecipe(name="name-of-the-recipe")
   3 ubuntu = launchpad.distributions["ubuntu"]
   4 ppa    = person.getPPAByName("name-of-ppa")
   5 for series in ubuntu.current_series:
   6     recipe.requestBuild(archive=ppa, distroseries=series, pocket="Release")