Repository navigation
chore(release): align credentials and document the compatibility policy - #43
Merged
Merged
Conversation
Use the documented token variable for both release steps and require the main branch. Production dependencies already pass the audit, so let development tools resolve their declared dependency ranges instead of overriding them.
Document the required checks and their bypass behavior. Preserve repository-derived label acceptance while warning about labels omitted from release notes. Define correctness-fix versioning and opt-in host format migrations, with verification limits taken from the target citations.
Fail documentation generation when a command lacks examples or exit-code guidance. Name the missing case and its source file so new commands cannot silently publish incomplete reference sections.
steve-calvert-glean
added
the
internal
steve-calvert-glean
marked this pull request as ready for review
October 21, 2026 23:54
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.
Problem
The release docs and config disagreed with each other and with the repository. RELEASE.md told maintainers to export
GITHUB_AUTH, but release-it readGITHUB_TOKEN, so following the docs silently turned the GitHub release into a manual browser step. RELEASE.md also claimed the label check ran inci.ymland blocked merges; it runs inpr-label.ymland blocked nothing. Nothing stopped a release from a branch other thanmain. The docs generator accepted a new command with no examples or exit codes. There was no written policy for how an upstream host format change ships.Change
GITHUB_AUTH, the same variable lerna-changelog uses, and requires themainbranch.mainrequirestest (22.12.0),test (24)andlabels; admins can bypass; reviews are not required. It documents the bot exemption, says that only five labels appear in the changelog, and says to pass the increment explicitly (npm run release -- minor) for breaking 0.x releases.formatvalue in a minor release. The default changes only in a major release. Each target lists the evidence it was verified against. It also adds a narrow patch-release exception for correctness fixes that change output.overridesare removed. The production dependency tree is byte-identical (npm ls --omit=dev --all), andnpm audit --omit=devstill reports zero vulnerabilities.pluginpack docsfails when a command lacks examples or exit codes.Testing
npm run checkpasses. New tests cover the docs-generator guards and the label workflow, including a PR labeled onlyquestion.