Skip to content

fix(release): verify tag annotation and signature via the API #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Radiergummi merged 1 commit into from
Jul 30, 2026
Merged

fix(release): verify tag annotation and signature via the API #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 15 additions & 8 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,23 +86,30 @@ jobs:

echo "Releasing ${version} to dist-tag '${channel}' (prerelease: ${prerelease})"

# An unsigned tag is an unauthenticated instruction to publish. GitHub's own verification
# status is used rather than importing keys here, so the check reflects the same trust GitHub
# shows in the UI.
# An unsigned tag is an unauthenticated instruction to publish.
#
# Both facts come from the API rather than the local repository, because `actions/checkout`
# materialises a tag ref as a LIGHTWEIGHT local tag pointing straight at the commit. So
# `git cat-file -t <tag>` reports `commit` inside a runner even for a properly annotated,
# verified tag — which is exactly what rejected a good v0.1.0 on the first attempt. The API sees
# the real object, and using it also means the signature check reflects the same trust GitHub
# shows in its UI.
- name: Tag is annotated and signed by a verified key
env:
GH_TOKEN: ${{ github.token }}
run: |
object_type="$(git cat-file -t "${GITHUB_REF_NAME}")"
ref="$(gh api "repos/${GITHUB_REPOSITORY}/git/ref/tags/${GITHUB_REF_NAME}")"
object_type="$(printf '%s' "${ref}" | jq -r '.object.type')"
object_sha="$(printf '%s' "${ref}" | jq -r '.object.sha')"

if [ "${object_type}" != 'tag' ]; then
echo "::error::${GITHUB_REF_NAME} is a lightweight tag; release tags must be annotated and signed"
echo "::error::${GITHUB_REF_NAME} is a lightweight tag (ref points at a ${object_type}); release tags must be annotated and signed"
exit 1
fi

tag_sha="$(git rev-parse "${GITHUB_REF_NAME}")"
verified="$(gh api "repos/${GITHUB_REPOSITORY}/git/tags/${tag_sha}" --jq '.verification.verified')"
reason="$(gh api "repos/${GITHUB_REPOSITORY}/git/tags/${tag_sha}" --jq '.verification.reason')"
verification="$(gh api "repos/${GITHUB_REPOSITORY}/git/tags/${object_sha}" --jq '.verification')"
verified="$(printf '%s' "${verification}" | jq -r '.verified')"
reason="$(printf '%s' "${verification}" | jq -r '.reason')"

if [ "${verified}" != 'true' ]; then
echo "::error::tag signature is not verified (${reason})"
Expand Down
Loading