launchpad help
|
|||
Source package recipes in Launchpad
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
- Set up daily build on Launchpad
- (Optional) Do a test build on Launchpad
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 there is no existing packaging for Debian or Ubuntu, you might want to have a look at http://wiki.ubuntu.com/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
A "recipe" is a description of the steps bzr-builder should take to construct a package from the various bzr branches. Its format 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 a basic recipe
With daily build recipes you have a number of options to get the source in place so it can be built.
build from trunk as is, if you have the debian/ directory with the packaging in trunk
use trunk and merge another branch, if you don't have the packaging in trunk but in another branch that can be merged in (for example: for a build you branched trunk for a specific tag (a specific release) and added the debian/ directory there -- this should merge cleanly with curren trunk)
use trunk and nest another branch, if you want to use a separate branch and put it into trunk in a specific location (most obvious use case: you nest the packaging into a ./debian directory in pristine trunk that does not have packaging yet, but note: the "packaging branch" needs to contain the files and not a ./debian directory, otherwise it'll end up in ./debian/debian which won't work)
The third alternative is one that is going to work in the most cases, which is why we'll highlight it here.
If you need anything more sophisticated or extensive documentation on all your options, please review our recipe documentation.
Simple Example
In this example we will use trunk which does not contain any packaging and nest a separate branch that contains JUST the packaging (contents of the ./debian/ directory).
The contents of the branch that is nested into are placed into a directory called ./debian.
# bzr-builder format 0.2 deb-version {debupstream}+{revno}+{revno:packaging}
lp:gtg
nest packaging lp:~gtg/gtg/debian debian
Testing locally
Testing the recipe
It's very important to test your recipe locally, because failed builds waste build farm resources, and may exceed your quota (currently 5 per distroseries per recipe per day). 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.
sudo apt-get install pbuilder
edit ~/.pbuilderrc and add
COMPONENTS="main universe multiverse restricted"
- 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.
Build daily: enables building the recipe daily, instead of only on-demand.
Daily build archive: the archive to upload the resulting source package into. (Only PPAs are currently supported.)
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
If you have checked "build daily", Launchpad will automatically schedule a build of your recipe once every day, if any of the branch tips have changed since the last build. However, it's a good idea to try building it yourself first, to make sure that everything is working correctly. You can use the "Request build(s)" link for this:
