Document release credentials and pin them to the workflows (T12) - #128
Merged
Merged
Conversation
The release chain is fully built, but nothing recorded the credentials an owner must configure, and the roadmap named two that do not exist. ## Behavior - `.llm/references/RELEASING.md` records the chain (prepare -> tag -> publish), the `RELEASE_TOKEN` secret and its scope, why the default `GITHUB_TOKEN` cannot complete a release, the npm Trusted Publisher fields, the rerun and recovery matrix, and the fail-closed guards. - `scripts/lint-release-secrets.js` cross-checks the documented credential set against the secrets the release workflows actually read, in both directions, and fails closed on a missing or empty documented block. Wired into `lint:llm:full`, llm-lint CI, and pre-commit. ## Validation - 10 new self-tests, both drift directions, clean/empty/malformed cases, and a check against this repository. Harness 18/18 files green. - Red on the real defect: documenting `AUTO_COMMIT_APP_ID` and `AUTO_COMMIT_APP_PRIVATE_KEY` fails as unread, and adding a secret to a release workflow without documenting it fails as undocumented. - Lint ladder green; `npm pack` payload unchanged at 172 files. ## Risk / Rollback - Docs and one new check; no workflow, script, or production behavior changes. Rollback by reverting this commit. Refs T12.
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.
The release chain is fully built, but no document recorded the credentials an owner must configure, and the roadmap named two that do not exist in the repository.
Behavior
.llm/references/RELEASING.mdrecords the chain (prepare, tag, publish), theRELEASE_TOKENsecret and its scope, why the defaultGITHUB_TOKENcannot complete a release, the npm Trusted Publisher fields, the rerun and recovery matrix, and the fail-closed guards.scripts/lint-release-secrets.jscross-checks the documented credential set against the secrets the release workflows read, in both directions, and fails closed on a missing or empty documented block. Wired intolint:llm:full, llm-lint CI, and pre-commit.Validation
AUTO_COMMIT_APP_IDandAUTO_COMMIT_APP_PRIVATE_KEYfails as unread, and adding a secret to a release workflow without documenting it fails as undocumented.npm packpayload unchanged at 172 files.Risk / Rollback
Refs T12.
Note
Low Risk
Documentation and harness lint only; release workflows and publish behavior are unchanged.
Overview
Adds owner-facing release documentation and a lint guard so release workflow secrets cannot drift from what the repo documents.
.llm/references/RELEASING.mddescribes the prepare → tag → publish chain, the requiredRELEASE_TOKEN(and whyGITHUB_TOKENalone can “succeed” without publishing), npm Trusted Publisher setup, rerun/recovery, and fail-closed release scripts. Thebump-version-releaseskill now points readers there before a first release or after a partial failure.scripts/lint-release-secrets.jsparses secrets fromrelease-prep.yml,release-tag.yml, andnpm-publish.ymland compares them to the<!-- release-secrets:begin/end -->table inRELEASING.md(both directions; ignoresGITHUB_TOKENand YAML comments). It is wired into pre-commit,lint:llm:full,llm-lintCI (including path filters on the three release workflows), plus 10 self-tests intest-lint-release-secrets.ps1.Reviewed by Cursor Bugbot for commit 2233e69. Bugbot is set up for automated code reviews on this repo. Configure here.