dawidd6 / deber

:package::whale2: Debian packaging with Docker

deber

Debian + Docker = deber

Utility made with simplicity in mind to provide an easy way for building Debian packages in Docker containers.

Screencast

Features

• Build packages for Debian and Ubuntu
• Use official Debian and Ubuntu images from DockerHub
• Automatically determine if target distribution is Ubuntu or Debian by querying DockerHub API
• Skip already ran steps (not every one)
• Install extra local packages in container
• Plays nice with gbp-buildpackage
• Easy local package dependency resolve
• Don't clutter your parent directories with .deb, .dsc and company
• Every successfully built package goes to local repo automatically so you can easily build another package that depends on previous one
• Ability to provide custom dpkg-buildpackage and lintian options
• Packages downloaded by apt are stored in temporary directory, to avoid repetitive unnecessary network load
• Option to drop into interactive bash shell session in container, for debugging or other purposes
• Use network in build process or not
• Automatically rebuilds image if old enough

Installation

Homebrew

brew install dawidd6/tap/deber

Source

go install github.com/dawidd6/deber@latest

Usage

I recommend to use deber with gbp if possible, but it will work just fine as a standalone builder, like sbuild or pbuilder.

Let's assume that you are in directory with already debianized source, have orig upstream tarball in parent directory and you want to build a package. Just run:

deber

or if you use gbp and have builder = deber in gbp.conf

gbp buildpackage

If you run it first time, it will build Docker image and then proceed to build your package.

To make use of packages from archive to build another package, specify desired directories with built artifacts and deber will take them to consideration when installing dependencies:

deber -p ~/deber/unstable/pkg1/1.0.0-1 -p ~/deber/unstable/pkg2/2.0.0-2

FAQ

Okay everything went well, but... where the hell is my .deb?!

The location for all build outputs defaults to $HOME/deber. I made it this way, because it was just hard to look at my parent directory, cluttered with .orig.tar.gz, .deb, .changes and God knows what else.

Where is build directory located?

/tmp/$CONTAINER

Where is apt's cache directory located?

/tmp/$IMAGE

How images built by deber are named?

deber:$DIST

I have already built image but it is building again?!

Probably because it is 14 days old and deber decided to update it.

How to build a package for different distributions?

Make a new entry with desired target distribution in debian/changelog and run deber.

Or specify the desired distribution with --distribution option.

How to cross-build package for different architecture?

This is not implemented yet. But I'm planning to make use of qemu or something else.

CONTRIBUTING

I appreciate any contributions, so feel free to do so!

deber's Issues

Look up build directory for upstream orig tarball

If exists there, just skip tarball step.

Print informations before building

• distribution
• package name
• package version
• image
• container
• dirs

Better Docker output handling

Reference:
https://www.nearform.com/blog/building-docker-images-in-go/

Logos licensing

Mention original authors with licenses of Docker, Debian and Go logos

Save Docker output to buffer in case an error occurs

As the title says. It would be nice to save Docker's output just in case of getting an error when verbose flag is set to false, get whole log and debug what went wrong.

Create man page

Use SVG icon in README

PNG looks blurry.

Scan after archiving

Run scan step after archive.

Seems to be better option, because this way the Packages file is always up-to-date.

Update apt's cache when it's old enough

https://unix.stackexchange.com/questions/271000/update-apt-get-cache-only-if-its-older-than-certain-time

Would be nice to not update the cache every time the packaging step is executed.

Need to mount this .bin file on host from container to /tmp dir.
Set the interval = 1h maybe.

Comment exported stuff

Title says it all.

M O A R comments.

Add option to pass build directory

Having /home and /tmp on separate BTRFS subvolumes, deber fails at Finding tarballs step with:

deber:error: rename /home/<user>/<package> /tmp/<container>/<package>: invalid cross-device link

It would be nice to have the option to pass the build directory as argument. Thanks!

Better CI

https://cirrus-ci.org/guide/docker-builder/

Add flags to lintian

-i and -I

Move to archive anyway

Don't skip this step if package is present in archive.

Why?

Just cause package is building successfuly doesn't mean it's good in every aspect.

Options after '--'

Arguments after -- will be threated as options passed to dpkg-buildpackage.

Allow building packages for other architectures

Not only amd64, but armhf and arm64 too.

Consider splitting to smaller steps

For example:
test step, split to:

• debc
• debi
• lintian

Store packaging output in one directory

Don't clutter ..

Step name suggestions

Suggest valid step name if provided one is wrong.

Allow to specify local .deb(s) to be installed in container before packaging

Allow to disable network when performing packaging step

Add option to pass arhive directory

Now you have hardcode link to home folder.

Prettify Dockerfile template

Automatically upgrade image if it's older than X days

It is essential to pull newer parent image and then rebuild.

Add option not testing package after build

subj

Add option to log in to shell in container

For debugging purposes.

Use flat project structure

New CLI

• build
  • --rebuild
• create
  • --recreate
• deps
  • --packages
• package
  • --network
• test
  • --network
  • --lintian
• remove
• shell
• status
• list
  • --containers
  • --images
  • --packages

Debianization

Test usage of apt instead of mk-build-deps

Executing apt-get build-dep ./ in source directory seems to work just fine and even better than mk-build-deps. Need to evaluate it further.

Run shell in container as root

Update AsciiArt in README

Present:

• dropping to shell
• including steps
• excluding steps
• running with gbp

Set user home dir to /nonexistent

Temporarily disable network in container

During package step, container should not be able to access internet.

Print help message when no arguments given

Installation via 'go get'

GetDockerfile in BuildImage

Get Dockerfile string directly in BuildImage function.

Bring back 'skipped' and 'done' to logging

But maybe in different form, like... some kind of progress bar on the bottom.

Add option to generate shell completions and manpage

Via cobra.

Comment on packages

// Package xyz provides something and something else...
//
// Stuff like that.
package xyz

Verbose logging

"Invalid cross-device link" error

Deber seems to be failing when creating a hard link for the orig tarball of my package. Perhaps deber should fall back to copying when linking fails.

Tried on Manjaro using the AUR package for Deber. Source tarball is on a /@home btrfs subvolume.

Not enough arguments in call to docker.cli.ContainerCreate

Greetings! I'm trying to install deber:

(base) [sm@fedora-mbp bmxlib-libmxf]$ go get -u github.com/dawidd6/deber
# github.com/dawidd6/deber/pkg/docker
/home/sm/go/pkg/mod/github.com/dawidd6/[email protected]/pkg/docker/container.go:130:38: not enough arguments in call to docker.cli.ContainerCreate
	have (context.Context, *container.Config, *container.HostConfig, nil, string)
	want (context.Context, *container.Config, *container.HostConfig, *network.NetworkingConfig, *v1.Platform, string)

Am I doing something wrong or is it a bug?

Use ANSI escape codes for colors

Rather than an additional dependency.

How i can pass or set environment variable in container?

subj

Disabling network

Seems like network disabling is buggy, cause sometimes when build flow is broken, every new Docker container has no internet access.

Debian backports

Ubuntu Docker image already contains backports repo, but Debian doesn't.

Maybe make an exception for Debian?

Checking if changelog line contains ~bpo should be enough I guess, to determine
that it is Debian backport since Ubuntu does not use this notation.

Move orig tarball, not copy