Tasks

Task types

Ontology for generic tasks

While tasks are unique in theory, we can have different tasks sharing some commonalities. In the Debian context in particular, we have different ways to build Debian packages with different helper programs (sbuild, pbuilder, etc.) and we want those tasks to reuse the same set of parameters so that they can be called interchangeably.

This public interface is materialized by a generic task that can be scheduled by the users and that will run one of the available implementations that can run on one of the available workers.

This section documents those generic tasks and their interface.

There are some task_data keys that apply to all tasks:

notifications (optional): a dictionary containing:
- on_failure (required): a specification of what to do if the task fails, formatted as an array of dictionaries as follows:
  - channel (required): the NotificationChannel to use for this notification
  - data (optional): a dictionary as follows (for email channels; this may change for other notification methods):
    - from (optional): the email address to send this notification from (defaults to the channel’s from property)
    - to (optional): a list of email addresses to send this notification to (defaults to the channel’s to property)
    - cc (optional): a list of email addresses to CC this notification to (defaults to the channel’s cc property, if any)
    - subject (optional): the subject line for this notification (defaults to the channel’s subject property, or failing that to WorkRequest $work_request_id completed in $work_request_result); the strings ${work_request_id} and ${work_request_result} (or $work_request_id and $work_request_result, provided that they are not followed by valid identifier characters) are replaced by their values

Task data key names are used in pydantic models, and must therefore be syntactically valid Python identifiers (although they may collide with keywords, in which case pydantic aliases should be used).

Many tasks look up their execution environment from a debian:environments collection. These lookups have architecture, format, and backend filters automatically added to them based on the task data’s host_architecture and backend fields, so it is normally only necessary to specify codename and perhaps variant (e.g. debian/match:codename=bookworm:variant=autopkgtest).

Task `PackageBuild`

A generic task to represent a package build, i.e. the act of transforming a source package (.dsc) into binary packages (.deb).

The task_data associated to this task can contain the following keys:

input (required): a dictionary describing the input data
- source_artifact (Single lookup, required): source artifact pointing to a source package, used to retrieve the source package to build.
- extra_binary_artifacts: (Multiple lookup, optional). List of artifacts. If provided these binary package artifacts (debian:binary-package or debian:binary-packages) are downloaded and made available to apt when installing build-dependencies.
distribution (required if backend is schroot): name of the target distribution.
environment (Single lookup with default category debian:environments), required if backend is not schroot): artifact of category debian:system-tarball or debian:system-image artifact, depending on the backend type. QEMU and INCUS_VM require a debian:system-image artifact, while the other backends require a debian:system-tarball.
backend (optional, defaults to unshare): If auto, the task uses the default. Supported backends: incus-lxc, incus-vm, qemu, schroot, and unshare.
extra_repositories (optional): a list of extra repositories to enable. Each repository is described by a dictionary with the following possible keys:
- sources_list: a single-line for an APT’s sources.list file
- authentication_key (optional): the ascii-armored public key used to authenticate the repository
host_architecture (required): the architecture that we want to build for, it defines the architecture of the resulting architecture-specific .deb (if any)
build_architecture (optional, defaults to the host architecture): the architecture on which we want to build the package (implies cross-compilation if different from the host architecture). Can be explicitly set to the undefined value (Python’s None or JavaScript’s null) if we want to allow cross-compilation with any build architecture.
build_components (optional, defaults to any): list that can contain the following 3 words (cf dpkg-buildpackage --build=any,all,source):
- any: enables build of architecture-specific .deb
- all: enables build of architecture-independent .deb
- source: enables build of the source package (.dsc)
build_profiles: list of build profiles to enable during package build (cf dpkg-buildpackage --build-profiles)
build_options: value of DEB_BUILD_OPTIONS during build
build_path (optional, default unset): forces the build to happen through a path named according to the passed value. When this value is not set, there’s no restriction on the name of the path.
binnmu (optional, default unset): build a binNMU:
- changelog: one line of text for the Debian changelog entry
- suffix: suffix appended to the binary package version, e.g. +b1
- timestamp (optional, default is now): changelog date
- maintainer (optional, default is uploader): changelog author

Task `SystemBootstrap`

A generic task to represent the bootstrapping of a Debian system out of an APT repository. The end result of such a task is to generate an artifact of category debian:system-tarball.

The task_data associated to this task can contain the following keys:

bootstrap_options: a dictionary with a few global options:
- variant (optional): maps to the --variant command line option of debootstrap
- extra_packages (optional): list of extra packages to include in the bootstrapped system
- architecture (required): the native architecture of the built Debian system. The task will be scheduled on a system of that architecture.
bootstrap_repositories: a list of repositories used to bootstrap the Debian system. Note that not all implementations might support multiple repositories.
- types (optional): a list of source types to enable among deb (binary repository) and deb-src (source repository). Defaults to a list with deb only.
- mirror (required): the base URL of a mirror containing APT repositories in $mirror/dists/$suite
- suite (required): name of the distribution’s repository to use for the bootstrap
- components (optional): list of components to use in the APT repository (e.g. main, contrib, non-free, …). Defaults to download the Release from the suite and using all the Components.
- check_signature_with (optional, defaults to system): indicates whether we want to check the repository signature with the system-wide keyrings (system), or with the external keyring documented in the in the keyring key (value external), or whether we don’t want to check it at all (value no-check).
- keyring_package (optional): install an extra keyring package in the bootstrapped system
- keyring (optional): provide an external keyring for the bootstrap
  - url (required): URL of the external keyring to download (must either have a host or be a file:// URL under /usr/share/keyrings/)
  - sha256sum (optional): SHA256 checksum of the keyring to validate the downloaded file
  - install (boolean, defaults to False): if True, the downloaded keyring is installed and used in the target system.
customization_script (optional): a script that is copied in the target chroot, executed from inside the chroot and then removed. It lets you perform arbitrary customizations to the generated system. You can use apt to install extra packages. If you want to use something more elaborated than a shell script, you need to make sure to install the appropriate interpreter during the bootstrap phase with the extra_packages key.

Some executor backends require specific packages to be installed in the tarball/image:

incus-lxc: Requires: extra_packages: [dbus, systemd, systemd-resolved, systemd-sysv], as the image has to be bootable and configure networking with systemd-networkd.

Task `SystemImageBuild`

This generic task is an extension of the SystemBootstrap generic task: it should generate a disk image artifact complying with the debian:system-image definition. That disk image contains a Debian-based system matching the description provided by the SystemBootstrap interface.

The following additional keys are supported:

disk_image
- format (required): desired format for the disk image. Supported values are raw and qcow2.
- filename (optional): base of the generated disk image filename.
- kernel_package (optional): name of the kernel package to install, the default value is linux-image-generic, which is only available on Bullseye and later, on some architectures.
- bootloader (optional): name of the bootloader package to use, the default value is systemd-boot on architectures that support it.
- partitions (required): a list of partitions, each represented by a dictionary with the following keys:
  - size (required): size of the partition in gigabytes
  - filesystem (required): filesystem used in the partition, can be none for no filesystem, swap for a swap partition, or freespace for free space that doesn’t result in any partition (it will thus just offset the position of the following partitions).
  - mountpoint (optional, defaults to none): mountpoint of the partition in the target system, can be none for a partition that doesn’t get a mountpoint.

Some executor backends require specific packages to be installed in the tarball/image or specific customization:

incus-vm: Requires: A kernel and bootloader, which the SimpleSystemImageBuild task will install. Also: python3 and customization_script: /usr/share/autopkgtest/setup-commands/setup-testbed to support the autopkgtest-virt-incus driver used by sbuild and autopkgtest.
qemu: Requires: A kernel and bootloader, which the SimpleSystemImageBuild task will install.

Specifications of tasks

This section lists all the available tasks, with the input that they are accepting, the description of what they are doing, including the artifacts that they are generating.

The tasks listed in this section are those that you can use to submit work requests.

Autopkgtest task

The task_data associated to this task can contain the following keys:

input (required): a dictionary describing the input data:
- source_artifact (Single lookup, required): the debian:source-package or debian:upload artifact representing the source package to be tested with autopkgtest
- binary_artifacts (Multiple lookup, required): a list of debian:binary-packages or debian:upload artifacts representing the binary packages to be tested with autopkgtest (they are expected to be part of the same source package as the one identified with source_artifact)
- context_artifacts (Multiple lookup, optional): a list of debian:binary-packages or debian:upload artifacts representing a special context for the tests. This is used to trigger autopkgtests of reverse dependencies, where context_artifacts is set to the artifacts of the updated package whose reverse dependencies are tested, and source/binary artifacts are one of the reverse dependencies whose autopkgtests will be executed.
host_architecture (required): the Debian architecture that will be used in the chroot or VM where tests are going to be run. The packages submitted in input:binary_artifacts usually have a matching architecture (but need not in the case of cross-architecture package testing, eg. testing i386 packages in an amd64 system).
environment (Single lookup with default category debian:environments, required): debian:system-tarball or debian:system-image artifact (as appropriate for the selected backend) that will be used to run the tests.
backend (optional): the virtualization backend to use, defaults to auto where the task is free to use the most suitable backend. Supported: incus-lxc, incus-vm, qemu, and unshare.
include_tests (optional): a list of the tests that will be executed. If not provided (or empty), defaults to all tests being executed. Translates into --test-name=TEST command line options.
exclude_tests (optional): a list of tests that will skipped. If not provided (or empty), then no tests are skipped. Translates into the --skip-test=TEST command line options.
debug_level (optional, defaults to 0): a debug level between 0 and 3. Translates into -d up to -ddd command line options.
extra_apt_sources (optional): a list of APT sources. Each APT source is described by a single line (deb http://MIRROR CODENAME COMPONENT) that is copied to a file in /etc/apt/sources.list.d. Translates into --add-apt-source command line options.
use_packages_from_base_repository (optional, defaults to False): if True, then we pass --apt-default-release=$DISTRIBUTION with the name of the base distribution given in the distribution key.
extra_environment (optional): a dictionary listing environment variables to inject in the build and test environment. Translates into (multiple) --env=VAR=VALUE command line options.
needs_internet (optional, defaults to “run”): Translates directly into the --needs-internet command line option. Allowed values are “run”, “try” and “skip”.
fail_on (optional): indicates whether the work request must be marked as failed in different scenario identified by the following sub-keys:
- failed_test (optional, defaults to true): at least one test has failed (and the test was not marked as flaky).
- flaky_test (optional, defaults to false): at least one flaky test has failed.
- skipped_test (optional, defaults to false): at least one test has been skipped.
timeout (optional): a dictionary where each key/value pair maps to the corresponding --timeout-KEY=VALUE command line option with the exception of the global key that maps to --timeout=VALUE. Supported keys are global, factor, short, install, test, copy and build.

Note

At this point, we have voluntarily not added any key for the --pin-packages option because that option is not explicit enough: differences between the mirror used to schedule jobs and the mirror used by the jobs result in tests that are not testing the version that we want. At this point, we believe it’s better to submit all modified packages explicitly via input:context_artifacts so that we are sure of the .deb that we are submitting and testing with. That way we can even test reverse dependencies before the modified package is available in any repository.

This assumes that we can submit arbitrary .deb on the command line and that they are effectively used as part of the package setup.

autopkgtest is always run with the options --apt-upgrade --output-dir=ARTIFACT-DIR --summary=ARTIFACT-DIR/summary --no-built-binaries.

An artifact of category debian:autopkgtest is generated to store all output files, and is described in the artifacts reference.

Mmdebstrap task

The mmdebstrap task fully implements the SystemBootstrap interface.

On top of the keys defined in that interface, it also supports the following additional keys in task_data:

bootstrap_options
- use_signed_by (defaults to True): if set to False, then we do not pass the keyrings to APT via the Signed-By sources.list option, instead we rely on the --keyring command line parameter.

The keys from bootstrap_options are mapped to command line options:

variant maps to --variant (and it supports more values than debootstrap, see its manual page)
extra_packages maps to --include

The keys from bootstrap_repositories are used to build a sources.list file that is then fed to mmdebstrap as input.

SimpleSystemImageBuild task

The simplesystemimagebuild task implements the SystemImageBuild interface except that it expects a single entry in the list of partitions: the entry for the root filesystem (thus with a mountpoint of /).

In terms of compliance with the SystemBootstrap interface, the bootstrap phase only uses a single repository but the remaining repositories are enabled after the bootstrap.

This task is implemented with the help of the debos tool.

Lintian task

The task_data associated to this task can contain the following keys:

input (required): a dictionary of values describing the input data, one of the sub-keys is required but both can be given at the same time too.
- source_artifact (Single lookup, optional): the debian:source-package or debian:upload artifact representing the source package to be tested with lintian
- binary_artifacts (Multiple lookup, optional): a list of debian:binary-package, debian:binary-packages, or debian:upload artifacts representing the binary packages to be tested with lintian (they are expected to be part of the same source package as the one identified with source_artifact)

Note

While it’s possible to submit only a source or only a single binary artifact, you should aim to always submit source + arch-all + arch-any related artifacts to have the best test coverage as some tags can only be emitted when lintian has access to all of them at the same time.

environment (Single lookup with default category debian:environments, required): debian:system-tarball artifact that will be used to run lintian. Must have lintian installed.
backend (optional): the virtualization backend to use, defaults to auto where the task is free to use the most suitable backend. Supported options: incus-lxc, incus-vm, unshare.
output (optional): a dictionary of values controlling some aspects of the generated artifacts
- source_analysis (optional, defaults to True): indicates whether we want to generate the debian:lintian artifact for the source package
- binary_all_analysis (optional, defaults to True): same as source_analysis but for the debian:lintian artifact related to Architecture: all packages
- binary_any_analysis (optional, defaults to True): same as source_analysis but for the debian:lintian artifact related to Architecture: any packages
target_distribution (optional): the fully qualified name of the distribution that will provide the lintian software to analyze the packages. Defaults to debian:unstable.
include_tags (optional): a list of the lintian tags that are allowed to be reported. If not provided (or empty), defaults to all. Translates into the --tags or --tags-from file command line option.
exclude_tags (optional): a list of the lintian tags that are not allowed to be reported. If not provided (or empty), then no tags are hidden. Translates into the --suppress-tags or --suppress-tags-from file command line option.
fail_on_severity (optional, defaults to none): if the analysis emits tags of that severity or higher, then the task will return a “failure” instead of a “success”. Valid values are (in decreasing severity) “error”, “warning”, “info”, “pedantic”, “experimental”, “overridden”. “none” is a special value indicating that we should never fail.

The lintian runs will always use the options --display-level ">=classification" (>=pedantic in jessie) --no-cfg --display-experimental --info --show-overrides to collect the full set of data that lintian can provide.

Note

Current lintian can generate “masked” tags (with M: prefix) when you use --show-overrides. For the purpose of debusine, we entirely ignore those tags on the basis that it’s lintian’s decision to hide them (and not the maintainer’s decision) and as such, they don’t bring any useful information. Lintian is full of exceptions to not emit some tags and the fact that some tags rely on a modular exception mechanism that can be diverted to generate masked tags is not useful to package maintainers.

For those reasons, we suggested to lintian’s maintainers to entirely stop emitting those tags in https://bugs.debian.org/1053892

Between 1 to 3 artifacts of category debian:lintian will be generated (one for each source/binary package artifact submitted) and they will have a “relates to” relationship with the corresponding artifact that has been analyzed. The debian:lintian artifacts are described in the artifacts reference.

Sbuild task

Regarding inputs, the sbuild task is compatible with the ontology defined for Task PackageBuild even though it implements only a subset of the possible options at this time.

Currently unsupported PackageBuild task keys:

extra_repositories
build_architecture
build_options
build_path

Output artifacts and relationships:

debian:package-build-log: sbuild output
- relates-to: source_artifact
- relates-to: b, c
debian:binary-package: one for each binary package (*.deb) built from the source package
- relates-to: source_artifact
debian:binary-packages: the binary packages (*.deb) built from the source package, grouped into a single artifact
- relates-to: source_artifact
debian:upload: c plus the right administrative files (.changes, .buildinfo) necessary for its binary upload
- extends: b, c
- relates-to: b, c
debusine:signing-input: the .changes file ready for signing if required
- relates-to: d
debusine:work-request-debug-logs: debusine-specific worker logs
- relates-to: source_artifact

Piuparts task

A specific task to represent a binary package check using the piuparts utility.

The task_data associated to this task can contain the following keys:

input (required): a dictionary describing the input data
- binary_artifacts (Multiple lookup, required): a list of debian:binary-packages or debian:upload artifacts representing the binary packages to be tested. Multiple artifacts can be provided so as to support e.g. testing binary packages from split indep/arch builds.
backend (optional, defaults to unshare). If auto, the task uses the default. Supported backends: incus-lxc, incus-vm, schroot, and unshare.
environment (Single lookup with default category debian:environments, required): artifact of category debian:system-tarball that will be used to run piuparts itself.
base_tgz (Single lookup with default category debian:environments, required): artifact of category debian:system-tarball that will be used to run piuparts tests, through piuparts --base-tgz. If the artifact’s data has with_dev: True, the task will remove the files /dev/* before using it.
host_architecture (required): the architecture that we want to test on.

The piuparts output will be provided as a new artifact.

Blhc task

A task to represent a build log check using the blhc utility.

The task_data associated to this task can contain the following keys:

input (required): a dictionary describing the input data
- artifact (Single lookup, required): a debian:package-build-log artifact corresponding to the build log to be checked. The file should have a .build suffix.
extra_flags (optional): a list of flags to be passed to the blhc command, such as --bindnow or --pie. If an unsupported flag is passed then the request will fail.

The blhc output will be provided as a new artifact of category debian:blhc, described in the artifacts reference.

The task returns success if `blhc` returns an exit code of 0 or 1, and failure otherwise.

UpdateDerivedCollection task

This is a generic server-side task that compares two collections, one of which is derived from the other, and creates any work requests necessary to update the derived collection.

The task_data for this task may contain the following keys:

base_collection (Single lookup, required): the “base” collection which we are using as a source of data
derived_collection (Single lookup, required): the “derived” collection that we are updating
child_task_data (optional): a dictionary to use as the task_data of child work requests, with additional items merged into it as indicated by the specific implementation; for example, it may be useful to specify an environment here
force (boolean, defaults to False): if True, schedule work requests for each matching artifact in the base collection regardless of whether there is already a corresponding artifact in the derived collection (for example, this might be useful when the implementation of the task has changed)

Specific tasks based on this interface are responsible for determining the relevant subsets of active items in each of the base and derived collections that are compared, for defining the desired derived item names given a set of base items, and for defining the work requests needed to perform each individual update to the derived collection.

This task takes the relevant subset of the derived collection and finds the items in the base collection from which each of them were derived, using derived_from in each of the per-item data fields. (Multiple items may be derived from the same base items.) It then compares these items to the relevant subset of the base collection and determines the derived items that need to be changed given the current contents of the base collection, in one of these ways:

add: a derived item is desired but does not exist
replace: a derived item is desired with the same name as one that already exists, but either its base items have changed or force is True
remove: a derived item exists but is not desired

The definition of a collection item’s name guarantees that only one active item with a given name may exist in any given collection, so it is a convenient key to use here.

For each derived item that should be added or replaced, the task creates suitable child work requests to create a new derived item and update the derived collection, according to the specific implementation. It only creates a work request if another work request with the same parameters does not already exist, or if force is True.

For each derived item that should be removed, the task immediately removes it from the derived collection.

If this task is part of a workflow, then each of the created work requests is created as a sub-step of it in the same workflow.

UpdateSuiteLintianCollection task

This task implements the UpdateDerivedCollection task interface, updating a derived debian:suite-lintian collection from a base debian-suite collection.

All active items in both collections are considered relevant.

Given a base debian:binary-package artifact with an architecture other than all, a derived item with the name {srcpkg_name}_{srcpkg_version}_{architecture} is desired.

Given a base debian:source-package artifact or for a base debian:binary-package artifact with Architecture: all, derived items with the names {srcpkg_name}_{srcpkg_version}_{architecture} are desired for the following values of architecture:

source (only for a source package artifact with no corresponding binary package artifacts)
all
each architecture where another base debian:binary-package artifact exists for the same source package name and version

The child work requests are for Lintian tasks, with the following task_data in addition to anything specified in this task’s child_task_data:

input:
- source_artifact (Single lookup): the relevant debian:source-package artifact in the base collection
- binary_artifacts (Multiple lookup): a list of the relevant debian:binary-package artifacts in the base collection

Each child work request has an event reaction as follows, where {derived_collection} is the derived_collection from this task’s data:

on_success:
  - action: "update-collection-with-artifacts"
    artifact_filters:
      category: "debian:lintian"
    collection: {derived_collection}

APTMirror task

This is a server-side task that updates an existing debian:suite collection to reflect the state of an external APT suite. It creates source and binary package artifacts as required.

The task_data for this task may contain the following keys:

collection (required): the name of the debian:suite collection to update
url (required): the base URL of the external repository
suite (required): the name of the suite in the external repository; if this ends with /, then this is a flat repository and components must be omitted
components (optional): if set, only mirror these components
architectures (required): if set, only mirror binary packages for this list of architectures
signing_key (optional): ASCII-armored public key used to authenticate this suite

Todo

architectures should be optional, but discovering the available architectures without having to implement delicate GPG verification code ourselves is hard; see message #49 in #848194.

The suite must have at least a Release file to make it possible to handle multiple architectures in a reasonable way, and if signing_key is specified then it must also have either an InRelease or a Release.gpg file. Source and binary packages must have SHA256 checksums.

Additions and removals of collection items are timestamped as described in Collections, so tasks that need a static view of a collection (e.g. so that all tasks in the same workflow instance see the same base suite contents) can do this by filtering on collection items that were created before or at a given point in time and were not yet removed at that point in time.

Todo

Document exactly how transactional updates of collections work in general: tasks need to see a coherent state, and simple updates to collections can be done in a database transaction, but some longer update tasks where using a single database transaction is impractical may need more careful handling. See discussion in !517.

GenerateKey task

This is a signing task that generates a new key on a signing worker and stores it for later use.

The task_data for this task may contain the following keys:

purpose (required): the purpose of the key to generate: uefi, or openpgp.
description (required): A text string with a human-readable description of the new key’s intended purpose.

The output will be provided as a debusine:signing-key artifact. The task should typically be configured with an update-collection-with-artifacts event reaction to attach the new signing key to the collection where it will be used, such as debian:suite-signing-keys.

Todo

This will need additional parameters once we start supporting HSMs.

ExtractForSigning task

This is a worker task that takes the output of the Sbuild task and extracts debusine:signing-input artifacts from them for use by the Sign task.

The task_data for this task may contain the following keys:

input (required): a dictionary describing the input data:
- template_artifact (Single lookup, required): a debian:binary-package artifact containing a template package
- binary_artifacts (Multiple lookup, required): a list of debian:binary-package, debian:binary-packages, or debian:upload artifacts used to find the packages referred to by the template’s files.json
environment (Single lookup with default category debian:environments, required): debian:system-tarball artifact that will be used to unpack binary packages using the unshare backend

The task operates as follows:

It extracts the /usr/share/code-signing/$binary_package_name/files.json file from the template binary package.
It checks that files.json uses only relative paths with no .. components.
For each package in the template’s files.json:
- It checks that the package name is a syntactically-valid Debian package name.
- It finds the corresponding package among the binary artifacts.
- If there is a trusted_certs entry, it copies it into the corresponding output artifact.
- For each file:
  - It checks that the file name uses only relative paths with no .. components, and that the resulting path within the extracted binary package does not traverse symlinks to outside the extracted binary package.
  - It stores a copy of the file in the output artifact with the name $package/$file.

The output will be provided as debusine:signing-input artifacts, one for each package in the template’s files.json, with each artifact having a relates-to relationship to the template package and to the binary package from which its files were extracted.

Sign task

This is a signing task that signs the contents of debusine:signing-input artifacts on a signing worker.

The task_data for this task may contain the following keys:

purpose (required): the purpose of the key to sign with: uefi or openpgp (needed separately from key so that the scheduler can check whether the worker has the necessary tools available)
unsigned (Multiple lookup, required): the debusine:signing-input artifacts whose contents should be signed
key (Single lookup, required): the debusine:signing-key artifact to sign with; must match purpose

The output will be provided as debusine:signing-output artifacts, each of which is related to the corresponding debusine:signing-input artifact.

AssembleSignedSource task

This is a worker task that takes debusine:signing-output artifacts produced by Sign tasks and assembles the resulting source package.

The task_data for this task may contain the following keys:

environment (Single lookup with default category debian:environments, required): debian:system-tarball artifact that will be used to pack the source package using the unshare backend. dpkg-dev will be installed there if necessary.
template (Single lookup, required): a debian:binary-package artifact containing a source template
signed (Multiple lookup, required): signed debusine:signing-output artifacts matching the template

The task operates as follows:

It makes a copy of the /usr/share/code-signing/$binary_package_name/source-template/ directory from the template binary package.
It checks that debian/source/format is exactly 3.0 (native) and that neither debian/source/options nor debian/source/local-options exists.
It checks that files.json uses only relative paths with no .. components.
For each package name and file name in the template’s files.json, it finds the corresponding file in the signed artifacts and copies it into debian/signatures/$package/$file.sig. For this to work, the names of the files in the debusine:signing-input and debusine:signing-output artifacts must be composed of the binary package name, followed by /, followed by the path in the corresponding file key in files.json.
It packs the resulting assembled source package using dpkg-source -b, and makes a suitable .changes file for it using dpkg-genchanges.

The output will be provided as a debian:source-package artifact, with a built-using relationship to the debian:binary-package artifacts that were related to the input to the Sign task, and a debian:upload artifact containing that source package and the corresponding .changes file.

Delay task

This wait task completes after its delay_until timestamp.

The task_data for this task may contain the following keys:

delay_until (datetime, required): a timestamp on or after which this task may be run

As with other wait tasks, the scheduler marks it running (without assigning a worker) as soon as possible after it is pending, after which it is considered to be waiting for its event to happen. Separately, it handles the completion of this particular task directly, by marking it as successfully completed if the current time is greater than or equal to its delay_until timestamp.

MakeSourcePackageUpload task

This worker task makes a debian:upload artifact from a debian:source-package artifact. This involves unpacking the source package and running dpkg-genchanges on it.

The task_data for this task may contain the following keys:

input (required): a dictionary describing the input data:
- source_artifact (Single lookup, required): a debian:source-package artifact
since_version (string, optional): include changelog information from all versions strictly later than this version in the .changes file; the default is to include only the topmost changelog entry
target_distribution (string, optional): override the target Distribution field in the .changes file to this value; the default is to use the distribution from the topmost changelog entry
environment (Single lookup with default category debian:environments, required): debian:system-tarball artifact that will be used to run dpkg-source and dpkg-genchanges using the unshare backend.

The output is a debian:upload artifact, with extends and relates-to relationships to the input source package artifact (to match the behaviour of debusine import-debian-artifact).

Used by the package_upload workflow.

MergeUploads task

This worker task combines multiple debian:upload artifacts into a single one, in preparation for uploading them together. This involves running mergechanges (from devscripts) on them, or equivalent.

The task_data for this task may contain the following keys:

input (required): a dictionary describing the input data:
- uploads (Multiple lookup, required): a list of debian:upload artifacts
environment (Single lookup with default category debian:environments, required): debian:system-tarball artifact that will be used to run mergechanges using the unshare backend.

The output is a debian:upload artifact with extends relationships to each of the input upload artifacts.

Used by the package_upload workflow.

Debsign task

This is a signing task that signs a debian:upload artifact on a signing worker. It is separate from the Sign task because signing uploads is a customized operation involving signing multiple files and possibly updating checksums in the .changes file to match the signed versions of other files.

The task_data for this task may contain the following keys:

unsigned (Single lookup, required): the debian:upload artifact whose contents should be signed
key (Single lookup, required): the debusine:signing-key artifact to sign the upload with, which must have purpose openpgp

The output will be provided as a debian:upload artifact, with relates-to relations to the unsigned and key artifacts.

Used by the package_upload workflow.

ExternalDebsign task

This wait task blocks until a user provides a signature for an upload.

The task_data for this task may contain the following keys:

unsigned (Single lookup, required): the debian:upload artifact whose contents should be signed

Running this task does not do anything. In order to complete it, the user needs to execute debusine provide-signature <work-request-id> to download the files to sign, sign them locally with debsign, upload them back as part of a new debian:upload artifact, and finally record that artifact as an output artifact of the ExternalDebsign task. The web UI advises the user to run this command when showing such a work request.

The containing workflow should then normally use an event reaction to add that output artifact to a suitable collection (usually the workflow’s internal collection).

The task does not verify the signature, since it doesn’t necessarily have the public key available. It remains the responsibility of whatever would normally verify the signature (e.g. an external upload queue) to do so.

Used by the package_upload workflow.

PackageUpload task

This server task uploads Debian packages to an upload queue.

It is the equivalent of running dput, but since other parts of debusine ensure that the upload is well-formed, there’s no need for most of the complexity of dput and we can avoid needing an environment for it.

The task_data for this task may contain the following keys:

input (required): a dictionary describing the input data:
- upload (Single lookup, required): a debian:upload artifact
target (required): the upload queue, as an ftp:// or sftp:// URL

The implementation should take care to use a suitable connection timeout. An SSH private key should be provided in the ~/.ssh/ directory of the user running debusine.

Used by the package_upload workflow.

DebDiff task

A task to compute the differences between two source or binary Debian packages using the debdiff utility.

The task_data associated to this task can contain the following keys:

input (required): a dictionary describing the input data
- source_artifacts (optional): a list with two elements. Each of type (Single lookup): source artifact pointing to a source package.
- binary_artifacts: (optional): a list with two elements. Each of type (Multiple lookup): binary artifact pointing to binary packages.

Note

Note that exactly one of source_artifacts or binary_artifacts is required.

extra_flags (optional): a list of flags to be passed to the debdiff command, such as --nocontrol or --diffstat. If an unsupported flag is passed then the request will fail.

The debdiff output will be provided as a new artifact of category debian:debdiff, described in the artifacts reference.

The task returns success if debdiff returns an exit code of 0 or 1, and failure otherwise.

Tasks

Ontology for generic tasks

Task PackageBuild

Task SystemBootstrap

Task SystemImageBuild

Specifications of tasks

Autopkgtest task

Mmdebstrap task

SimpleSystemImageBuild task

Lintian task

Sbuild task

Piuparts task

Blhc task

UpdateDerivedCollection task

UpdateSuiteLintianCollection task

APTMirror task

GenerateKey task

ExtractForSigning task

Sign task

AssembleSignedSource task

Delay task

MakeSourcePackageUpload task

MergeUploads task

Debsign task

ExternalDebsign task

PackageUpload task

DebDiff task

Task `PackageBuild`

Task `SystemBootstrap`

Task `SystemImageBuild`