Repository navigation
docs: announce security fixes with an advisory or deprecation - #203
Merged
Merged
Conversation
Downstream projects and templates often pin a release a few days old on purpose, behind release-age gates. A fix that appears only in the changelog has no GitHub security advisory and no npm deprecation, so nothing tells those pins to move. The release checklist now asks the maintainer to publish an advisory or deprecate affected versions after a security fix ships, and SECURITY.md tells users to expect that. llms-full.txt is regenerated with `pnpm llms:generate` because it embeds SECURITY.md. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #203 +/- ##
=======================================
Coverage 94.19% 94.19%
=======================================
Files 148 148
Lines 11834 11834
Branches 2796 2796
=======================================
Hits 11147 11147
Misses 229 229
Partials 458 458 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Summary
Adds the maintainer release rule for security fixes: when a release fixes a security issue, publish a GitHub security advisory for the repository or deprecate the affected versions on npm.
SECURITY.mdtells users to expect this.Changes
PUBLISHING.md: a step at the end of "Verify the published version" stating the rule, with thenpm deprecateform, and the reason (downstream projects and templates pin a few-day-old release on purpose behind release-age gates; a fix only in the changelog gives those pins no advisory and no deprecation).SECURITY.md: one sentence under "Supported versions" saying security fixes are announced through a GitHub security advisory or by deprecating affected versions on npm.llms-full.txt: regenerated withpnpm llms:generate, since it embedsSECURITY.md. Only the one sentence changed.No past release is claimed to have followed this rule.
Testing
pnpm install --frozen-lockfile: succeeded.pnpm check: exit 0. Covers build, example and template typecheck, oxlint, oxfmt,tsc --noEmit,doc:lint,doc:check,doc:links, andllms:check.🤖 Generated with Claude Code