Debian Pbuilder

ID: debian-pbuilder

This plugin allows you to build deb packages in a pbuilder environment.

This plugin is based largely off of jenkins-debian-glue.

Find pre-built versions of this plugin on this Jenkins instance!

Build Status

System Setup

Before you can successfully run the plugin, there are certain requirements that must be met on the node(s) that you wish to run on.  

  1. Install needed dependencies:

    apt-get install qemu-user-static devscripts cowbuilder dpkg-dev
  2. If building Debian packages on Ubuntu, make sure that the package debian-archive-keyring is installed 

  3. Like jenkins-debian-glue, make sure that sudo is configured properly. As taken from the jenkins-debian-glue webpage, add the following to either /etc/sudoers, or create a new file(e.g. /etc/sudoers.d/jenkins): 

    jenkins ALL=NOPASSWD: /usr/sbin/cowbuilder, /usr/sbin/chroot 
    Defaults env_keep+="DEB_* DIST ARCH"

    (this assumes that Jenkins is running under the Jenkins user)

Using the Plugin

Configuration Options

There are several global configuration options.  These options may be found by going to "Manage Jenkins" → "Configure System".  

  • Email address - this is the email that is set in the changelog entry for the build.  It need not be an actual email address
  • Version format - Determines how the package will be versioned if not a tag build
  • Debian directory - determines where the debian/ folder is, by default the project should be checked out to a directory called 'source'

Project Setup(Traditional)

This plugin may be configured as both a traditional Jenkins build, or as a Pipeline project.

  1. Create a new project.  If you want to build for multiple architectures, select "Multi-configuration project"

  2. Checkout source code.  When you checkout the source code for the project, it should be in a subdirectory called 'source'(this value can be changed on either a per-build configuration or globally).  This can be done as either an SVN repository, or a git repository.  To checkout to the proper directory using git, go to "Additional Behaviors" and select "Check out to a sub-directory", and put "source" as the value.  To checkout to the proper directory using SVN, under "Local module directory" put "source" as the value.

  3. Under 'Build Environment', select 'Delete workspace before build starts'

  4. If you have a matrix configuration project, add a new variable called "architecture".  Put in the proper architectures to build for in this section; this must map to a valid architecture that exists in the distribution repos.

  5. Under the 'Build' section, add 'Debian Pbuilder'. Most of these settings may be left at their default values, however it is highly recommended to fill in the "Distribution" and "Mirror Site" variables in order to ensure that you get a consistent build.  Otherwise, pbuilder will use the defaults for whatever distribution you are currently running.

  6. If you have custom pbuilder hook files that you want to install, install the Config File Provider to add in config files. Set the 'target' option to be `hookdir/<file-name>`.

Project Setup(Pipeline)

If using pipeline, you may setup a job similar to the following:

Pipeline Setup - single arch

node {
    ws {
        stage( "clean" ){
        stage( "checkout" ){
            checkout([$class: 'GitSCM', branches: 
                        [[name: '*/jenkinsfile-updates']], 
                        doGenerateSubmoduleConfigurations: false, 
                        extensions: [[$class: 'RelativeTargetDirectory', relativeTargetDir: 'source']], 
                        submoduleCfg: [], 
                        userRemoteConfigs: [[credentialsId: '78de5c66-5dfb-4c95-8ad9-ec34e8dee4ec', url: '']]])

            //Actually build the package.
            //Note that you can go to the 'Pipeline Syntax' page on your Jenkins instance to generate this automatically
            debianPbuilder additionalBuildResults: '', architecture: '', distribution: 'jessie', keyring: '', mirrorSite: ''


The following example shows how to build for multiple architectures:

Pipeline Setup - Multiple arch

def axisArchitecture = ["amd64", "armhf"]
def axisNode = ["master"]
def tasks = [:]

for( int i = 0; i < axisArchitecture.size(); i++ ){
    def arch = axisArchitecture[i];
    tasks["${axisNode[0]}/${axisArchitecture[i]}"] = {
                stage( "clean" ){
                stage( "checkout" ){
                    checkout([$class: 'GitSCM', branches: 
                             [[name: '*/jenkinsfile-updates']], 
                             doGenerateSubmoduleConfigurations: false, 
                             extensions: [[$class: 'RelativeTargetDirectory', relativeTargetDir: 'source']], 
                             submoduleCfg: [], 
                             userRemoteConfigs: [[credentialsId: '78de5c66-5dfb-4c95-8ad9-ec34e8dee4ec', url: '']]])
                    debianPbuilder architecture:"${arch}"

    parallel tasks

Package Versioning

By default the plugin will increment the current version number by reading 'debian/changelog'.  The algorithm follows the standard Debian practice of packages having a ~ being a pre-release version, and packages with a + denoting a version greater than what is default.  Note that this only happens if the the distribution set in 'debian/changelog' is UNRELEASED, or a tag is being built.  Tags are automatically scanned; if using SVN or git, the environment variables SVN_URL_1 and GIT_BRANCH are scanned for the substring "tags/"; if the substring is found, the package will be built as a tag.  Otherwise, you can also select the "Build as tag" to force the package to not increment the version number, or alternatively set the environment variable DEB_PBUILDER_BUILDING_TAG if you are building a tag.


All generated files are automatically added to the build artifacts for easy retrieval.  This includes the deb files, as well as the dsc and tar files used to build the package in the pbuilder environment.


All output can be found in the build output of the project when it is built.  If for some reason the build fails, this is a good first place to look.  If there is a configuration problem, a (hopefully) useful error message will be printed out when the build fails.  

Building packages with 'quilt' format

When building a package with format "3.0 (quilt)", you must provide the orig.tar.gz file for the builder to work properly.  This can be done one of two ways: either you can provide the orig.tar.gz through a pre-build step of some kind, or under the 'advanced' section there is a field for you to fill in the name of the package to checkout using the 'pristine-tar' command.

Issue Tracking

Please file any bugs that you may find on the Jenkins JIRA, using the debian-pbuilder-plugin component.  Click here for all open issues.

ArchivesGet past versions
Version: 1.8
Requires Jenkins 2.204.6
Installs: 59
This plugin has no labels
Robert Middleton
Help us improve this page!
To propose a change submit a pull request to the plugin page on GitHub.