GitHub - cargo-bins/release-rust: NOT RECOMMENDED FOR USE. WAIT FOR V1. All-in-one action to build, optimise, tag, sign, and publish a Cargo-based Rust project.

While all the functionality is here, this action is alpha quality. If you use it, you will experience frustration. For production or stress-free use, wait for v1.

An all-in-one action to build, optimise, tag, sign, and publish a Cargo-based Rust project.

Purpose

This action is your one-stop shop for building and publishing a Rust project. It will:

Install the Rust toolchain and target, including necessary components
Use cross for cross-compilation if needed
Enable some useful compiler options by default, like:
- building the standard library (-Z build-std),
- codegen units for maximum optimisations (-C codegen-units=1),
- static linking of libgcc for musl builds (-C link-arg=-static-libgcc),
- outputting split debuginfo (-C split-debuginfo=packed).
Package binaries and support files in an archive
Sign the archive with sigstore's cosign and rekor
Tag the release if it isn't already, and sign the tag with gitsign
Publish the crate to crates.io
Publish the archives to GitHub Releases

It can be used standalone, as part of your own release workflow, or alongside our own release-pr and release-meta actions. See the onrelease workflow in the test repo for a complete example of the latter.

Sounds complicated? Fear not! In most cases, using this action is the job of only few lines of YAML:

permissions:
  id-token: write
  contents: write

steps:
- uses: actions/checkout@v3
- uses: cargo-bins/release-rust@v0
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    crates-token: ${{ secrets.CRATES_TOKEN }}
    target: ${{ matrix.target }}

Examples
Documentation
Ecosystem
- What about cargo-dist
- What about rust-build

Examples

Basic usage

This example runs when pull requests tagged with a release label are merged to the main branch.

It builds the project for six targets (x64 and ARM64 for the big three platforms) and otherwise uses all defaults: compiles with build-std, packs the debuginfo, uses zip archives, publishes to crates.io, pushes a tag, publishes to GitHub releases, and uploads signatures to sigstore. The binaries can then be securely installed with cargo binstall.

name: Release on PR merge
on:
  pull_request:
    types: closed
    branches: [main] # target branch of release PRs

jobs:
  release:
    if: github.event.pull_request.merged && contains(github.event.pull_request.labels.*.name, 'release')
    strategy:
      fail-fast: false
      matrix:
        include:
        - { o: macos-latest,    t: x86_64-apple-darwin        }
        - { o: macos-latest,    t: aarch64-apple-darwin       }
        - { o: ubuntu-latest,   t: x86_64-unknown-linux-musl  }
        - { o: ubuntu-latest,   t: aarch64-unknown-linux-musl }
        - { o: windows-latest,  t: x86_64-pc-windows-msvc     }
        - { o: windows-latest,  t: aarch64-pc-windows-msvc    }

    name: ${{ matrix.t }}
    runs-on: ${{ matrix.o }}
    permissions:
      id-token: write
      contents: write

    steps:
    - uses: actions/checkout@v3
    - uses: cargo-bins/release-rust@v0
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }}
        crates-token: ${{ secrets.CRATES_TOKEN }}
        target: ${{ matrix.t }}

Running on tags

This example runs when a version tag is pushed. While the action would detect the tag exists before pushing it, we disable tag publishing to save a little time. Otherwise it does everything the above example does.

name: Release on tag push
on:
  push:
    tag: v*.*.*

jobs:
  release:
    strategy:
      fail-fast: false
      matrix:
        include:
        - { o: macos-latest,    t: x86_64-apple-darwin        }
        - { o: macos-latest,    t: aarch64-apple-darwin       }
        - { o: ubuntu-latest,   t: x86_64-unknown-linux-musl  }
        - { o: ubuntu-latest,   t: aarch64-unknown-linux-musl }
        - { o: windows-latest,  t: x86_64-pc-windows-msvc     }
        - { o: windows-latest,  t: aarch64-pc-windows-msvc    }

    name: ${{ matrix.t }}
    runs-on: ${{ matrix.o }}
    permissions:
      id-token: write
      contents: write

    steps:
    - uses: actions/checkout@v3
    - uses: cargo-bins/release-rust@v0
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }}
        crates-token: ${{ secrets.CRATES_TOKEN }}
        target: ${{ matrix.t }}
        publish-tag: false

Installing compile-time dependencies

Here we build a project that requires compiler-rt (provided in Ubuntu by libblocksruntime-dev), but only for the x86_64-unknown-linux-musl target. The post-setup hook is used to install the dependency after the action finishes setting up the build environment.

- uses: cargo-bins/release-rust@v0
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    crates-token: ${{ secrets.CRATES_TOKEN }}
    target: ${{ matrix.target }}
    post-setup: |
      if [ "${{ runner.os }}" = "Linux" ] && [ "${{ matrix.target }}" = "x86_64-unknown-linux-musl" ]; then
        sudo apt install -y libblocksruntime-dev # for compiler-rt
      fi

Custom build: justfile

Here we have a project that uses just to build the project. A post-setup hook is also used here to install the just CLI tool: it does so using cargo-binstall which is installed by the action as part of setup. Because custom-build is used, the action won't install the rust-src component by default, so we add it manually as well.

- uses: cargo-bins/release-rust@v0
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    crates-token: ${{ secrets.CRATES_TOKEN }}
    target: ${{ matrix.target }}
    extra-rustup-components: rust-src
    post-setup: |
      cargo binstall -y --force just
      just ci-install-deps
    custom-build: just build

Custom build: meson

Here's a hypothetical configuration for a project which uses meson to build. A post-setup hook is used to install meson, and the project's dependencies. Finally, the package-files option is used to gather the build outputs to package, as the meson build won't have put anything in the places the action expects to find them. Note that this example doesn't provide a crates-token, so the action won't publish to crates.io.

- uses: cargo-bins/release-rust@v0
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    target: ${{ matrix.target }}
    post-setup: |
      sudo apt install -y meson ninja appstream-glib glib2 gtk4 libadwaita libpanel gtksourceview vte-2.91-gtk4
      meson _build --prefix=/usr/local
    custom-build: ninja -C _build
    package-files: |
      _build/src/pods
      _build/po
      _build/data/*

Compile out panic messages

While this is not an optimisation that is on by default, it can be useful to reduce the size of binaries. By passing a few extra flags, we can instruct the compiler to remove all panic messages from the binary. This is done by forcing panic = "abort" in the release profile and enabling the immediate-abort-on-panic feature for build-std:

- uses: cargo-bins/release-rust@v0
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    crates-token: ${{ secrets.CRATES_TOKEN }}
    target: ${{ matrix.target }}
    extra-cargo-flags: |
      --config='profile.release.panic="abort"'
      -Z build-std=std,panic_abort
      -Z build-std-features=panic_immediate_abort

Universal binaries on macOS

The release-lipo action is not yet available.

A macOS concept is universal binaries, which contain code for multiple architectures. This action cannot build these directly, but the companion release-lipo action will read from an existing release, download *-apple-darwin packages and extract them, combine the binaries with lipo, then repackage and upload the result:

name: Release on tag push
on:
  push:
    tag: v*.*.*

jobs:
  release:
    strategy:
      fail-fast: false
      matrix:
        include:
        - { o: macos-latest,    t: x86_64-apple-darwin        }
        - { o: macos-latest,    t: aarch64-apple-darwin       }
        - { o: ubuntu-latest,   t: x86_64-unknown-linux-musl  }
        - { o: ubuntu-latest,   t: aarch64-unknown-linux-musl }
        - { o: windows-latest,  t: x86_64-pc-windows-msvc     }
        - { o: windows-latest,  t: aarch64-pc-windows-msvc    }

    name: ${{ matrix.t }}
    runs-on: ${{ matrix.o }}
    permissions:
      id-token: write
      contents: write

    steps:
    - uses: actions/checkout@v3
    - uses: cargo-bins/release-rust@v0
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }}
        crates-token: ${{ secrets.CRATES_TOKEN }}
        target: ${{ matrix.t }}
        publish-tag: false

  lipo:
    needs: release
    runs-on: macos-latest
    permissions:
      id-token: write
      contents: write

    steps:
    - uses: cargo-bins/release-lipo@v1
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }}

Filtering crates

Within a workspace, sometimes only a subset of crates should be build and packaged. This set of crates is adjustable with the crates option, which takes a newline-separated list of crate names:

- uses: cargo-bins/release-rust@v0
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    crates-token: ${{ secrets.CRATES_TOKEN }}
    target: ${{ matrix.target }}
    crates: |
      my-crate
      my-other-crate

When there are many crates with similar names, you can use glob patterns to match them:

- uses: cargo-bins/release-rust@v0
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    crates-token: ${{ secrets.CRATES_TOKEN }}
    target: ${{ matrix.target }}
    crates: |
      *-cli
      other-tool

How this works is that the action will run cargo metadata to get a list of all crates in the workspace, then filter that list by the glob patterns.

You can also use negative patterns to exclude crates:

- uses: cargo-bins/release-rust@v0
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    crates-token: ${{ secrets.CRATES_TOKEN }}
    target: ${{ matrix.target }}
    crates: |
      *-cli
      !not-this-cli

You should take care to read through the behaviour section for multiple crate publishing. Notably, you may want to set the first crate in the list explicitly as it may affect names and tags.

Filtering binaries

By default, all binaries in the workspace, or in the set of crates being built, will be packaged. To filter these, use the pre-package hook to run a script that will remove unwanted binaries:

- uses: cargo-bins/release-rust@v0
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    crates-token: ${{ secrets.CRATES_TOKEN }}
    target: ${{ matrix.target }}
    pre-package: |
      rm -r example{-,_}tool{,.*}

The {-,_} and {,.*} expressions will match both the binary on unix and windows, and the debuginfo packages for that binary, without matching files that start with the same thing, like example-tool* would.

Publishing to crates.io before or after packaging anything

You may want to control when the crate is published to crates.io, or stop the release if it fails. This cannot be done directly with this action, as by nature it will run in parallel across the job's target matrix. However, you can set up a dependent job that runs before or after the release job:

name: Release on tag push
on:
  push:
    tag: v*.*.*

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - uses: cargo-bins/release-rust@v0
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }}
        crates-token: ${{ secrets.CRATES_TOKEN }}
        publish-crate-only: true

  release:
    needs: publish
    strategy:
      fail-fast: false
      matrix:
        include:
        - { o: macos-latest,    t: x86_64-apple-darwin        }
        - { o: macos-latest,    t: aarch64-apple-darwin       }
        - { o: ubuntu-latest,   t: x86_64-unknown-linux-musl  }
        - { o: ubuntu-latest,   t: aarch64-unknown-linux-musl }
        - { o: windows-latest,  t: x86_64-pc-windows-msvc     }
        - { o: windows-latest,  t: aarch64-pc-windows-msvc    }

    name: ${{ matrix.t }}
    runs-on: ${{ matrix.o }}
    permissions:
      id-token: write
      contents: write

    steps:
    - uses: actions/checkout@v3
    - uses: cargo-bins/release-rust@v0
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }}
        target: ${{ matrix.t }}
        publish-tag: false
        publish-crate: false

You should take note of the particular behaviour of the publish-crate-only option.

Provide checksum files

While signatures should be preferred, it can be a good practice to provide checksum files alongside the packages. This can be done with the post-sign hook, to avoid checksum files being signed:

- uses: cargo-bins/release-rust@v0
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    crates-token: ${{ secrets.CRATES_TOKEN }}
    target: ${{ matrix.target }}
    post-sign: |
      cd "$RELEASE_PACKAGE_OUTPUT"
      for file in *; do
        sha256sum "$file" | cut -d ' ' -f 1 > "$file.sha256"
        _rr_add_pkg ".packageFiles | contains([\"$file\"])" "$file.sha256"
      done

The _rr_add_pkg tool is a helper for editing the .crates.json file. It takes a jq expression to select the crate object(s) to edit, and a filename. This is critical when package-separately is set, and optional otherwise.

Distribute signatures alongside packages

By default, sigstore signatures and certificates are not distributed alongside the packages. This means that to verify a package, one must compute the SHA256 checksum of the package, and use it to look up the signature and certificate from Rekor.

However, you sometimes want to distribute these alongside the package, to make it easier to verify or to designate a specific certificate as the official one.

- uses: cargo-bins/release-rust@v0
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    crates-token: ${{ secrets.CRATES_TOKEN }}
    target: ${{ matrix.target }}
    extra-cosign-flags: |
      # write the signature in binary and the certificate in PEM
      --b64=false
      # the $OUTPUT variable is the name of the file being signed
      --output-certificate "$OUTPUT.pem"
      --output-signature "$OUTPUT.sig"
    post-sign: |
      # add the signature and certificate to the .crates.json file.
      for file in "$RELEASE_PACKAGE_OUTPUT"/*.sig; do
        output="${file%.sig}"
        _rr_add_pkg ".packageFiles | contains([\"$output\"])" "$file"
      done
      for file in "$RELEASE_PACKAGE_OUTPUT"/*.pem; do
        output="${file%.pem}"
        _rr_add_pkg ".packageFiles | contains([\"$output\"])" "$file"
      done

Sign using GPG instead

When package-sign is false, the packages won't be signed with cosign, but the post-sign hook will still run. You can use that to sign the packages with other tools, like GPG:

- uses: cargo-bins/release-rust@v0
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    crates-token: ${{ secrets.CRATES_TOKEN }}
    target: ${{ matrix.target }}
    package-sign: false
    post-sign: |
      cd "$RELEASE_PACKAGE_OUTPUT"
      for file in *; do
        gpg --detach-sign --armor "$file"
        _rr_add_pkg ".packageFiles | contains([\"$file\"])" "$file.asc"
      done

Inputs

Name	Default	Description
🔑 Credentials
`github-token`	required	A github token to interact with the API and to use for OIDC.
`crates-token`	optional	A crates.io token with publish scope for the crate(s). If not provided, crates will not be published.
🧰 Setup options
`toolchain`	`'nightly'`	The rust toolchain to use.
`target`	host target	The target to install and build for.
`binstall-version`	latest	Specify the cargo-binstall version to use (0.20.0 and above).
`cosign-version`	latest 1.x	Specify the cosign version to use (1.13.0 and above).
`rekor-version`	latest 1.x	Specify the rekor version to use (1.0.0 and above).
`gitsign-version`	latest	Specify the gitsign version to use (0.4.0 and above).
`cross-version`	latest	Specify the cross version to use (0.2.0 and above).
⚒️ Build options
`crates`	all crates	Newline-separated pattern list of crates to build within the workspace.
`features`	optional	Newline-separated features to enable when building.
`buildstd`	see Build-std	Set to `false` to disable building the standard library from source.
`debuginfo`	see Split debuginfo	Set to `false` to disable generating and outputting split debuginfo.
`musl-libgcc`	`true`	Set to `false` to disable static-linking libgcc for musl builds.
`crt-static`	see C runtime linking	Statically link the C runtime.
`use-cross`	see Build phase	Force use/non-use of cross to compile. By default, will use cross if the target is not the host target.
🚩 Extra flags
`extra-rustup-components`	optional	Extra components to install with rustup.
`extra-cargo-flags`	optional	Extra flags to pass to cargo build.
`extra-rustc-flags`	optional	Extra flags to pass to rustc (RUSTFLAGS).
`extra-cosign-flags`	optional	Extra flags to pass to cosign.
🥡 Packaging
`package-archive`	`'zip'`	Packaging archive format.
`package-files`	optional	Newline-separated pattern list of files to include in the package in addition to compiled binaries.
`package-name`	see Packaging and `package-separately`	Name of the package, excluding the extension.
`package-in-dir`	`true`	Wrap the package contents in a directory with the same name before archiving.
`package-separately`	`false`	Package each crate separately.
`package-short-ext`	`false`	Use the short variant of the archive extension, if relevant for the format. E.g. `tgz` instead of `tar.gz`.
`package-output`	`'packages/'`	Path to write finished packages to.
`package-sign`	`true`	Set to `false` to disable signing packages (with sigstore by default).
📦 Crate publishing
`publish-crate`	`true`	Set to `false` to disable publishing to crates.io.
`publish-crate-only`	`false`	Set to `true` to only publish to crates.io. See Crates.io publish only mode for how this affects hooks.
`publish-all-crates`	`false`	Set to `true` to publish to crates.io all crates that need it.
🎫 Tags
`tag`	version	Tag to create or use for the release. Set to `false` to disable tagging. This will imply `release: false`.
`tag-crates`	`true`	Set to `false` to disable tagging crate publishes.
`tag-sign`	`true`	Set to `false` to disable signing tags (with sigstore by default).
🚢 Github release
`release`	`true`	Set to `false` to disable publishing a GitHub release. Packages will be left in the `packages/` directory.
`release-name`	version	Name of the github release.
`release-notes`	optional	Body of the github release.
`release-separately`	`false`	Create a release for each crate.
`release-latest`	see Release phase	Set to `false` to not mark the release as the latest, or to a crate name to mark as latest if `release-separately` is `true`.
`release-pre`	`false`	Set to `true` to mark the release as a pre-release, or to a newline-separated pattern list of crates to mark so.
🪝 Hooks
`post-setup`	optional	Script to run after toolchain setup.
`post-publish`	optional	Script to run after publishing to registry.
`custom-build`	optional	Completely custom build script. Compilation options and extra cargo/rustc flags will be ignored if this is set.
`post-build`	optional	Script to run after building.
`pre-package`	optional	Script to run immediately before packaging.
`post-package`	optional	Script to run after packaging.
`post-sign`	optional	Script to run after signing.
`post-release`	optional	Script to run after releasing to Github.
`hooks-shell`	`'bash'`	Shell to use for all hooks.

The action needs no dependencies and runs on all hosted-spec runners (or compatible).

Outputs

All outputs of a Github Action are strings.

Name	Description
`files`	Newline-separated list of files generated by the action. This does not include all built files, only those within the `package-output` path.

Newline-separated pattern lists

Several inputs are "newline-separated pattern lists". These are newline-separated lists of glob patterns that are matched against some input list of items. If an item matches any of the patterns, it is included in the output list.

The list may also contain negative patterns, which are prefixed with !. If an item matches a negative pattern, regardless of whether it matches a positive pattern, it is excluded from the list.

Matching is done using minimatch.

Github token permissions

The github token needs to have:

write permission for id-token (OIDC for signing)
write permission for contents (releases and tags)

Checkout

You're responsible for checking out the repository at the right commit for the build. In most cases, this will be the default behaviour of actions/checkout@v3, but in some situations you may need to specify its ref input.

This action also does not bump versions or commit to the repository. You can use release-pr for that if you want a PR-based workflow, push to the repository directly, or use a different tool. It's up to you.

Build-std

The build-std feature lets Cargo compile the standard library itself. It generally produces smaller or better-optimized binaries, but it's not always available, desired, or even working.

This action uses build-std if:

the toolchain selected is the latest nightly, or a dated nightly after 2020-01-01, and
the target is one of a hardcoded list of targets, and
the buildstd input is not set to false.

Debuginfo

The split-debuginfo feature lets rustc produce separate debuginfo files for binaries. This can significantly reduce the size of the final executable, while providing a way to debug it if needed. Specifically, the packed variant of the feature produces a single file containing all debuginfo, which is handy for packaging and distributing!

This action uses split-debuginfo if:

the toolchain selected is the latest stable or nightly, a stable >=1.65.0, or a dated nightly after 2022-09-01, and
the debuginfo input is not set to false.

C runtime linking

The crt-static feature controls whether the C runtime is statically or dynamically linked. This is by default set by the target, but can be overridden. We set it to true on MSVC targets, to produce portable executables which do not need the runtime installed separately, and to false if the target is *-alpine-linux-musl, to conform with Alpine's expectation that musl is dynamically linked to. Otherwise the crt-static input is left empty, and the target's default will be used.

Packaging

The package-archive input selects the package archive format. For all compressed formats, the maximum compression setting is used.

Value	Description
`none`	Do not archive the package. This is an advanced option, and you should use package hooks alongside it, otherwise you may not have anything to upload.
`zip`	ZIP archive, with DEFLATE compression. This is the default, as it has the widest compatibility.
`tar+gzip`	Posix (pax) TAR archive, with GZIP compression.
`tar+bzip2`	Posix (pax) TAR archive, with BZIP2 compression.
`tar+xz`	Posix (pax) TAR archive, with XZ compression.
`tar+zstd`	Posix (pax) TAR archive, with ZSTD compression.

There's no support to select different formats based on the target: if you wish to, you should make that logic yourself in the workflow, prior to calling this action.

The package-name input is a template string that will be used to name the package, and defaults to {release-name}-{target}. The following placeholders can be used:

{target}: The target being built for.
{crate-name}: The name of the crate being packaged.
{release-name}: The name of the release being created.
{crate-version}: The version of the crate being packaged.
{release-version}: The version of the release being created.

See the With multiple crates section for more details on the difference between crate and release names and versions.

Custom build

When providing a custom-build script, the action will ignore:

features
buildstd
debuginfo
musl-libgcc
use-cross
extra-cargo-flags
extra-rustc-flags

It will also not move the built binaries and debuginfo to the temporary packaging directory, so you must do that with the pre-package hook and/or with the package-files input.

With multiple crates

When the action is run in a workspace, it will build and package all crates in the workspace by default, but it will use the "first" binary crate as the source for the names and versions of the release and package, and only publish that one to crates.io.

That "first" crate is determined by sorting the names of all binary crates in the workspace in lexicographic order, and using the first one, or by the first entry in the crates input. If the first entry in the crates input is a glob pattern, the first lexicographic match in its expansion will be used. This is also called the release-name (e.g. in the package-name template).

This behaviour makes it easy to use the action in the common situation of a workspace with a single binary crate and multiple library crates it depends on or relates to. For other situations, options are available to specify what and how to build, publish, and package.

`publish-all-crates`

With publish-all-crates: true, the action will look up the versions of all crates in the workspace against the registry, and publish all the ones that are not already published. This is separate from the crates input and build configuration: if a crate is not published, it will still be built and packaged if it is in the crates list.

However, it does affect the Github releases if release-separately is true: each published crate will be released, even if no package was generated for it.

If tag or tag-crate is false, crates will be published to the registry, but not tagged in the repository. Otherwise, a tag will be created for each published crate.

`package-separately`

The action will create a package for each crate's binaries. The package-name input changes its default to {crate-name}-{target}, so that each package has a different name.

By default, all packages will be uploaded to the same release. If release-separately is true, each package will be uploaded to its own release.

`release-separately`

The action will create a tag and release for each published crate, and upload the package (if any) for that crate to that release. It implies package-separately: true.

The release-notes and release-name inputs will attempt to parse as JSON. If they are valid JSON, they will be parsed as an object mapping crate names to their respective values. If they are not, they will be used as that value for all crates. The $default$ key can be used to specify a value that will be used for crates not otherwise present in the object.

See Tag phase and Release phase for how this input affects them.

Crates.io publish only mode

When publish-crate-only is true, the action will only publish to crates.io. This is useful in some cases like splitting the crates.io publish and the rest as the toolchain setup can then be easily kept consistent between the two jobs.

In that mode:

The setup phase is run.
The publish phase is run.
- If publish-all-crates is true, and:
  - all the crates are already up to date, the action fails.
  - any crate needs publishing, they are.
- otherwise, only the first/"release" crate is published:
  - if it is already up to date, the action fails.
The action stops there.

If you want to only publish to crates.io and not package the binaries in a separate job or workflow, you should not use this action, and do something like this instead:

- uses: actions/checkout@v3
- run: |
    rustup toolchain install stable --profile minimal --no-self-update
    rustup default stable
- run: cargo publish

Signing

Signing uses sigstore's public infrastructure.

Artifact signing using Sigstore works by obtaining the SHA256 checksum of an artifact, signing that checksum with a use-once certificate which asserts facts about the signing party, and then uploading the signature to a public ledger called Rekor. The certificate is obtained by generating a key pair locally, and then submitting a request along with an OIDC token to the Fulcio authority, which bakes the claims from the OIDC token into a certificate with a short validity.

In our case, the OIDC token is obtained from GitHub, and the claims include the repository name/org, inciting workflow, and commit information, among other details.

Artifact verification, as implemented in Cargo Binstall, relies on the Rekor public ledger: the SHA256 checksum of the artifact is looked up in Rekor, which contains one or more signatures for the sum. Each signature includes which certificate was used to sign, and that in turn contains the OIDC claims. As Binstall knows the repository URL, it verifies that the OIDC claims match, assuring that the artifact was created and signed in the context of a GitHub Action on that repository.

In the default configuration, the signature and certificate are only kept in Sigstore. You can also configure the action to upload those to the GitHub release, which "blesses" a specific signature as the one that should be used to verify the artifact, and only requires the verifier to check the authenticity of the certificate.

Action flow

A particularity is that hooks run even if their phase's purpose is disabled, so they can be used to replace the functionality of a phase without changing the rest of the action.

Setup phase

All of these are always performed, even if the phase they are used in is disabled: this makes it possible to use hooks to replace phases without having to download these tools.

Rust:

If buildstd is true, the rust-src component is added to the extra-rustup-components.
The toolchain is installed, in minimal profile, with the required components.
The target is added.
The toolchain is set as the default.

Binstall:

Version 0.20.0 is downloaded for the current platform, and checked against checksums hardcoded in this action (bootstrap).
Binstall is securely self-upgraded to the latest (or desired) version.

Cross:

taiki-e/install-action's cross manifest is downloaded, and the URL and checksum for the desired version and platform are extracted.
Cross is downloaded, checked, and installed.

Cosign:

Version 1.13.1 is downloaded for the current platform, and checked against checksums hardcoded in this action (bootstrap).
Cosign is securely self-upgraded to the latest (or desired) version.
rekor is downloaded, verified, and installed.
gitsign is downloaded, verified, and installed.
- if tag-sign: true, gitsign is set as the signing program for git, and tags are set to be signed by default.

The git user is configured:

Name: GitHub Actions (release-rust)
Email: the internal github email address for GitHub Actions.

The post-setup hook is run.

Publish phase

The action looks up the name of every crate in the workspace.
The crates input is evaluated as a list of globs, and matched against this list. The result is the list of crates to package and release.
The action queries the registry for the versions of each crate from that list (or from the list of all crates if publish-all-crates is true) and compares them to the local version.
- If the local version is already published, and:
  - release-separately is true: the crate is removed from the list of crates.
  - release-separately is false: the crate is removed only from the list of crates to publish.
- Otherwise, the crate is kept in the list.
Crates from that list that are publishable are published to the registry.
- if publish-crate-only is true and the list is empty, the action fails.
The post-publish hook is run.
If publish-crate-only is true, the action stops here.

Build phase

The value of use-cross is determined as follows, in this order:

if it is provided as input, that value is used;
if the target input is the host target, it is false;
if the target input is in a hardcoded list of cross targets, it is true;
otherwise, it is false.

If custom-build is set, it is called.

Otherwise, the build command is assembled and called:

if use-cross is true, the cross command is used instead of cargo.
the --release cargo profile is used.
the --target cargo option is set to the target input.
a --package option is added for each crate in the list of crates to build.
if buildstd is true, flags to build std as part of compilation are added to cargo.
if debuginfo is true, flags to produce packed split debuginfo are added to cargo.
if musl-libgcc is true, flags to statically link libgcc are added to RUSTFLAGS iff the target's libc variant is musl.
if crt-static is set, the -C target-feature= rustflag is set to either +crt-static (if true) or -crt-static (if false).
- otherwise, if the target contains -alpine-linux-musl, it is set to -crt-static.
- otherwise, if the target is MSVC, it is set to +crt-static.
the extra-cargo-flags input is stripped of newlines, parsed as shell (for quotes), and appended to cargo.
the extra-rustc-flags input is stripped of newlines, parsed as shell (for quotes), and appended to RUSTFLAGS.

The post-build hook is run.

Package phase

If package-separately is true, the following is run for each crate. Otherwise, it is run once.

A temporary directory is created.
A directory is created inside named the crate's name.
If package-in-dir is true, another directory named package-name is created inside that directory, to put files in instead.
If custom-build was not used, the binaries and debuginfo are copied to the temporary directory.
The package-files input is evaluated and its results are copied to the temporary directory.
The pre-package hook is run (for each package if package-separately is true).
If package-archive is not none, the temporary directory is archived and named package-name with the archive-appropriate extension, into the package-output directory.

The post-package hook is run (only once).

Sign phase

If package-sign is true, then for each file in the package-output directory:

The file is signed with cosign sign-blob --yes, using GitHub's OIDC identity and keyless signing.
- If signing fails, the file is skipped and an error is logged.

The post-sign hook is run (only once).

Tag phase

If tag is not false, and:

publish-all-crates and release-separately are both false:
- The tag input is evaluated as a template (same placeholders as package-name).
- An annotated tag is created at the current commit.
  - If tag-sign is true, the tag is signed with gitsign.
otherwise
- for each published crate:
  - The tag input is evaluated with crate-name and crate-version as that crate's.
  - An annotated tag is created at the current commit (and signed if enabled).
- for the release as a whole, if the release-crate is not within the set of published crates:
  - The tag input is evaluated as normal.
  - An annotated tag is created at the current commit (and signed if enabled).
All created tags are pushed to the repo.

The post-tag hook is run (only once).

Release phase

If release is not false, and:

release-separately is false:
- The release-name input is evaluated as a template (same placeholders as package-name, plus release-tag set to the tag name).
- A release is created (if not already present) with the tag created in the previous phase:
  - its name as the release-name result;
  - its body as the release-notes input (evaluated as a template, same placeholders as package-name, plus release-tag set to the tag name and release-name set to the release name);
  - marked as latest if release-latest is equal to the release-name or not false;
  - marked as pre-release if release-pre is true or matching the release-name.
- The $RELEASE_PACKAGE_OUTPUT/.crates.json file is read, all the packageFiles arrays are concatenated and deduplicated, and each file is uploaded as an asset to the release.
- All non-hidden files in the package-output directory are uploaded to the release if they haven't been already.
otherwise, for each tag created in the previous phase:
- Each of the release-name and release-notes inputs:
  - is attempted to parse as JSON. If it can be, and it is an object, each key is evaluated as a glob pattern against the list of crates, from most precise (proportion of glob characters) to least, and the first match is used. If no match is found, the action fails. If the value is not JSON, this step is skipped.
  - the value is then evaluated as a template with that crate's crate-name and crate-version.
- A release is created (if not already present) with the tag:
  - its name as the release-name result;
  - its body as the release-notes input;
  - marked as latest if release-latest is equal to the release-name or not false;
  - marked as pre-release if release-pre is true or matching the release-name.
- The $RELEASE_PACKAGE_OUTPUT/.crates.json file is read, and the object matching the crate being released is used to obtain the list of assets (packageFiles) to upload.

The post-release hook is run (only once).

Hook context

Hooks run in different working directories:

Hook	Working directory
`post-setup`	Runs in the "release root" (see below).
`post-publish`	Runs in the "release root".
`custom-build`	Runs in the "release root".
`post-build`	Runs in the "release root".
`pre-package`	Runs in a temporary directory filled with the built binaries and other `package-files`.
`post-package`	Runs in the `package-output` directory.
`post-sign`	Runs in the `package-output` directory.
`post-release`	Runs in the "release root".

Besides the GitHub runner environment variables, these are set for all hooks:

Name	Description
`RELEASE_ROOT`	The absolute path to the root of the workspace or crate being released.
`RELEASE_PACKAGE_OUTPUT`	The absolute path to the directory where packages are created (`package-output`).
`RELEASE_TARGET`	The target being built for.

And some are set for specific hooks:

`pre-package`

Name	Description
`RELEASE_PACKAGE_NAME`	The rendered `package-name`.
`RELEASE_PACKAGE_CRATE_NAME`	The name of the crate being packaged.
`RELEASE_PACKAGE_CRATE_VERSION`	The version of the crate being packaged.
`RELEASE_PACKAGE_SEPARATELY`	The value of `package-separately`.
`RELEASE_PACKAGING_DIR`	The absolute path to the temporary directory the packaged files were copied to.

`post-package`

Name	Description
`RELEASE_PACKAGE_SEPARATELY`	The value of `package-separately`.
`RELEASE_PACKAGING_DIR`	The absolute path to the temporary directory the packaged files were copied to.

The `.crates.json` file

At the root of the RELEASE_PACKAGE_OUTPUT dir, a .crates.json file contains an array of objects:

{
  name: string;
  version: string;

  // Files generated by the build phase (unless custom-build was used),
  // plus files resolved from package-files.
  files: string[];

  // The rendered package-name.
  packageName: string;

  // The name of the generated package file (created by the package phase).
  packageFiles: string[];
}

This is created during the packaging phase. When the pre-package hook is run, the packageFiles array is empty. The package archive, if created, is added afterwards. For implementation reasons, edits to the file during the pre-package hook are not preserved.

If you want to add files to the release, and you have package-separately: true, you must add them both to the $RELEASE_PACKAGE_OUTPUT directory and to this file in the relevant object (= crate), in the packageFiles array, before the release phase.

If you're not using package-separately, this isn't required, as all non-hidden (not starting with a .) files in the output folder will be uploaded to the release.

The _rr_add_pkg tool, described above, can be used to add to this file in a somewhat convenient way.

A file that is present in this manifest but not in the output directory will be ignored.

Ecosystem

This action doesn't exist in a vacuum. Not only are there related actions which can be used in conjunction with this one, there are alternatives which may be more suitable or just more familiar.

cargo-bins/release-pr and cargo-bins/release-meta

These are release management actions, by the same author as this one. Release-PR uses cargo-release to create a PR which bumps the version of the crate, so that releases can be submitted and reviewed collaboratively. It also adds JSON metadata in a comment on the PR, which can be read with the release-meta companion action to reliably trigger an actual release when a release PR is merged.

cargo-bins/release-lipo

Not yet available.

This action is a little helper which downloads archives on an existing GitHub Release, extracts pre-built binaries for macOS Intel and ARM targets, and combines them into a universal binary, which it then signs and uploads to the same release.

cargo-bins/release-manifest

Not yet available.

This action downloads archives on an existing GitHub Release, and builds a manifest of the packages and their contents, in cargo-dist format. It then uploads the manifest to the same release.

taiki-e/install-action

This is a handy action for installing useful Rust (and related) tools.

rust-build

This is an older action with a similar purpose as this one, but a more limited scope and different approach. It exclusively uses cross-compilation from Linux and only supports a few targets, but it may be simpler to use! Has support for stripping and compressing binaries with UPX.

cargo-dist

This isn't an action but a tool to configure Continuous Delivery (CD) for a Cargo project, to build and publish binaries for all supported platforms. It's a lot easier to use than this action! Use cargo-dist if you want to get set up quickly and don't need signing or the advanced features we got; you can always switch to this action later (and use release-manifest to keep compatible!). Cargo-dist also aims to support more CI providers, while we're GitHub Actions only.

Name		Name	Last commit message	Last commit date
Latest commit History 124 Commits
.github		.github
__tests__		__tests__
assets		assets
dist		dist
lib		lib
src		src
.editorconfig		.editorconfig
.eslintignore		.eslintignore
.eslintrc.json		.eslintrc.json
.gitattributes		.gitattributes
.gitignore		.gitignore
.prettierignore		.prettierignore
.prettierrc.json		.prettierrc.json
LICENSE		LICENSE
README.md		README.md
action.yml		action.yml
jest.config.js		jest.config.js
package-lock.json		package-lock.json
package.json		package.json
rebuild.sh		rebuild.sh
tsconfig.json		tsconfig.json

License

cargo-bins/release-rust

Folders and files

Latest commit

History

Repository files navigation