Skip to content

Commit f612825

Browse files
committed
docs(ci): note immutable-release dependency on the release job
This repo will have GitHub immutable releases enabled — publishing a release locks its tag + assets. That requires the reusable release workflow to create a draft, attach all assets, then publish (see Zondax/_workflows#110), which the pinned @v10 tag now carries. Document that constraint on the release job so the pin isn't rolled back to a tag predating the draft→publish flow. No functional change (pin stays @v10). Closes #481
1 parent 2cb15e3 commit f612825

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

.github/workflows/ci.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -655,6 +655,14 @@ jobs:
655655
# disagrees with the manifest BEFORE any binary builds; `e2e` includes the
656656
# (blocking) Windows arm, so a tag won't release unless Windows e2e is green.
657657
needs: [check, nix-package, e2e, test-macos, test-windows, version-consistency]
658+
# This repo has GitHub immutable releases ENABLED: publishing a release locks
659+
# its tag + assets (they can't be added/modified/deleted afterward). That
660+
# REQUIRES the reusable workflow to create the release as a draft, attach all
661+
# assets, then publish as the final step — which @v10 does (see
662+
# Zondax/_workflows#110). Do NOT pin back to a tag predating that change, or
663+
# the post-publish asset uploads will be rejected and releases will break. The
664+
# `release: published` event package-publish.yml triggers on still fires (from
665+
# the publish transition at the end of the `Upload release assets` job).
658666
uses: zondax/_workflows/.github/workflows/_release-rust.yml@v10
659667
with:
660668
binary_name: kache

0 commit comments

Comments
 (0)