Release process

GitHub releases and crates.io publish

paperless-cli now follows the same release shape as damacus/zitadel-tui, adapted for this crate and repository layout.

What happens on main

  1. release-please updates the release PR, tags, and changelog.
  2. The tagged revision is checked out after a release is created.
  3. The Linux binary is built and packaged as paperless-linux-amd64.tar.gz.
  4. checksums-sha256.txt is generated for the packaged artifacts.
  5. The tarball and checksum file are attached to the GitHub release.
  6. The crate is published to crates.io with cargo publish.

Required secrets

  • GITHUB_TOKEN: used by release-please and release asset upload steps.
  • CARGO_REGISTRY_TOKEN: required for the crates.io publish step.

Required crate metadata

The crate metadata now includes description, license, repository, homepage, readme, keywords, and categories so the first publish can succeed cleanly.

This page is intentionally new so the first Rust release has an explicit, visible release-process document in the tree.