Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 34 additions & 1 deletion .github/workflows/docker-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,9 @@ jobs:
needs: build
runs-on: ubuntu-latest
permissions:
contents: write
contents: write # create the GitHub Release
id-token: write # Sigstore signing certificate for the attestation below
attestations: write # store that attestation with the repository
steps:
- uses: actions/checkout@v7

Expand Down Expand Up @@ -321,6 +323,37 @@ jobs:
echo "have_notes=false" >> "$GITHUB_OUTPUT"
fi

# Signed SLSA build provenance for the release archives, so anyone can
# check that an archive was built by this workflow from its release tag
# (DEPLOY.md has the full command):
# gh attestation verify calnode_<version>_linux_amd64.tar.gz --repo Calnode/calnode \
# --signer-workflow Calnode/calnode/.github/workflows/docker-publish.yml \
# --source-ref refs/tags/v<version>
# The attestation is stored with the repository, and the bundle is also
# attached to the release as calnode_<version>.sigstore.json, so it can
# be checked from the file (`--bundle`) as well as through the API. This
# runs on the dry run too, so the step is exercised before a real tag
# needs it; a dry run's attestation names its branch, not a release tag,
# so the --source-ref check above never accepts it.
- name: Attest build provenance for the archives
id: attest
uses: actions/attest@1e69f48acb82d1966a394da916b4c1698aa569d6 # v4.2.2
with:
subject-path: dist/release/*.tar.gz

- name: Add the attestation bundle to the release files
env:
BUNDLE: ${{ steps.attest.outputs.bundle-path }}
run: |
set -euo pipefail
test -s "$BUNDLE"
# On a tag this is the version (v0.14.0 gives 0.14.0). A dry run from
# a branch such as ci/foo gets calnode_ci-foo.sigstore.json: a slash
# here would name a directory that does not exist.
name="${GITHUB_REF_NAME#v}"
cp "$BUNDLE" "dist/release/calnode_${name//\//-}.sigstore.json"
ls -l dist/release

# Preinstalled gh CLI + GITHUB_TOKEN (no third-party action — keeps the
# supply-chain surface small).
- name: Create GitHub Release
Expand Down
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ exact tag (`ghcr.io/calnode/calnode:0.1.0`) if you need stability between upgrad
then to English. Dates and times in the admin follow that locale. Public booking pages
and emails still use the existing 11-locale booker catalogs; the LiveKit room stays
English.
- **Release archives carry signed build provenance.** The release job now creates a
[GitHub artifact attestation](https://docs.github.com/en/actions/how-tos/secure-your-work/use-artifact-attestations/use-artifact-attestations)
(SLSA build provenance, signed through Sigstore) for the standalone `.tar.gz`
archives, and attaches the bundle to the release as `calnode_<version>.sigstore.json`.
`gh attestation verify` checks that an archive was built by `docker-publish.yml`
in this repository from its release tag; the full command is in
[DEPLOY.md](DEPLOY.md#standalone-binary).

### Changed

Expand Down
19 changes: 19 additions & 0 deletions DEPLOY.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,25 @@ The archive does **not** include Litestream or the container entrypoint. Setting
the binary directly; configure Litestream separately or use another SQLite-aware
backup method. The email, calendar and other integration settings below still apply.

Releases also carry `calnode_<version>.sigstore.json`, a signed
[build provenance](https://docs.github.com/en/actions/how-tos/secure-your-work/use-artifact-attestations/use-artifact-attestations)
attestation for the archives. To check that an archive was built by this
repository's release workflow from the release tag, with the
[GitHub CLI](https://cli.github.com/):

```bash
gh attestation verify "calnode_${version}_linux_amd64.tar.gz" --repo Calnode/calnode \
--signer-workflow Calnode/calnode/.github/workflows/docker-publish.yml \
--source-ref "refs/tags/v${version}"
```

To check against the downloaded bundle instead of GitHub's attestation API, add
`--bundle "calnode_${version}.sigstore.json"`. Without `--signer-workflow` and
`--source-ref`, the command only checks that the archive was built by a workflow in
this repository, which also matches the release workflow's dry runs.

Releases published before this was added have checksums only.

---

## 1. Configuration (environment variables)
Expand Down
Loading