tuxpkg

release automation tool for Python projects

Documentation - Repository - Issues

TuxSuite, a suite of tools and services to help with Linux kernel development.

[[TOC]]

Installing tuxpkg

There are several options for using tuxpkg:

• From PyPI
• Debian packages
• RPM packages
• Run uninstalled

gitlab CI pipeline

How to use:

!!!note gpg manual

1. repository settings

!!!note both the branch and repository tags must be protected!

Protected branch

Protected tags

2. CI/CD variables

The following variables must be set as protected in the CI/CD configuration:

• TUXPKG_RELEASE_KEY:

  • variable type: "file"
  • ascii-armored export of gnupg private key to sign the package repositories.

  !!!note Because the private key will be uploaded into GitLab CI, you want to create a new GPG key for your project only. DO NOT upload your own private key! :-)

  gpg --export-secret-keys --armor KEYID

• TUXPKG_RELEASE_KEYID:

  • variable type: "Variable"
  • variable options: "Protected"
  • the public gnupg key ID used to sign the package repositories. The is the full GPG key id, e.g. 1EC68783C596C4AD1C2E45896D082F7024A0AEAF.

  gpg -k

• FLIT_PASSWORD:

  • variable type: "Variable"
  • variable options: "Protected, Masked"
  • Generate a project-specific token on pypi.org

  !!!note pypi api token help

• FLIT_USERNAME:

  • variable type: "Variable"
  • variable options: "Protected"
  • set value to __token__

The following variables don't need to be protected. They can be set in the project settings as well, but it's probably better to set them explicitly in .gitlab-ci.yml.

• SKIP_BUILD_DEB, SKIP_BUILD_RPM. Set these to 1 to skip building RPM and Debian packages, respectively.

3. Setup .gitlab-ci.yml file

include:
  - https://gitlab.com/Linaro/tuxpkg/raw/main/gitlab-ci-pipeline.yml
variables:
  # ... override variables here (see below)

Variables that can be overriden locally:

• TUXPKG: how to call tuxpkg. Default: tuxpkg.

GitHub Actions

When using GitHub Actions, two additional settings must be configured:

1. Enable GitHub Pages: Settings -> Pages -> Source: GitHub Actions

2. Allow tag deployments: Settings -> Environments -> github-pages -> Add deployment rule for v* tags