Repository navigation
docs: point app authors at the release template that signs outside the build - #89
Merged
Merged
Conversation
…e build Project-Colony-Resources retires templates/release.yml and templates/sign-release.sh: that template signed inside the build jobs, where every dependency's build.rs and proc-macros run next to the key. templates/sign-and-publish-caller.yml is now the only release template, and signing happens in the organisation's shared workflow. README, CONTRIBUTING, the docs index and the manifest spec linked the retired files and told app authors to run sign-release.sh themselves. They now link the caller template and say that an app signs nothing itself. The workflows/ pointer file, which only redirected to the retired template, is removed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What was wrong
Project-Colony-Resources PR #10 retires
templates/release.ymlandtemplates/sign-release.sh. That template signed inside the build jobs, wherecargo buildruns every dependency'sbuild.rsand proc-macros next to the key, andCOLONY_SIGNING_KEY_PEMis also the key Colony trusts for its own self-updates. Colony's docs still linked those two files (they 404 once #10 merges) and told app authors to sign with./scripts/sign-release.shand a local key.What changed
README.md,CONTRIBUTING.md(step 3),docs/docs.mdanddocs/colony-spec.mdlinktemplates/sign-and-publish-caller.yml, the one release template left, and the shared signing workflow it calls.docs/colony-spec.mdno longer tells app authors to run a signing script: an app signs nothing itself, the shared workflow writes.sig,.metaand.meta.sig. Thevalidate-manifestparagraph says where the template runs it (the Linux build job, before anything is signed)..github/workflows/colony-rust-release.yml.templateis removed. It was only a pointer to the retired template, and it told readers to copytemplates/sign-release.sh.Colony's own
scripts/sign-release.shanddocs/release-signing.mdare untouched: they describe Colony's manual re-signing path, not the Resources templates.How it was verified
grep -rn 'templates/release.yml\|templates/sign-release\|colony-rust-release'over the tree prints nothing. Every new link targets a file or anchor that exists on Resourcesmaintoday (templates/sign-and-publish-caller.yml,design/releases.md#shared-signing-workflow), so this can merge before or after Resources #10.