Docs: Update supported versions and security patching details#33842
Conversation
Clarified security patching policy for supported versions and updated example version.
Clarified the policy on backporting security fixes and specified supported versions based on CVSS scores.
kylegach
left a comment
There was a problem hiding this comment.
Looks good! I suggested adding some links to the CVSS definition.
Co-authored-by: Kyle Gach <kyle.gach@gmail.com>
📝 WalkthroughWalkthroughThe pull request updates the security vulnerability policy for the project to use a tiered, major-version-based approach. The latest major version receives all security patches, the previous two major versions receive only High or Critical CVSS (7.0+) patches, and older versions receive no patches. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/releases/index.mdx`:
- Line 31: Fix the typo in the release note sentence that reads "Older versions:
No longer recieves any patches" by changing "recieves" to "receives" so the line
reads "Older versions: No longer receives any patches"; locate and update that
exact string in the docs/releases/index.mdx content.
| We actively maintain the latest major version of Storybook. Within the current major, we patch only the latest minor version. Most fixes and new work go into the next minor (or sometimes major) and are not backported. Critical security fixes may be backported more broadly based on severity: | ||
| - Latest major: Receives all security fixes | ||
| - Previous two majors: Receive security patches for **High or Critical [CVSS vulnerabilities](https://en.wikipedia.org/wiki/Common_Vulnerability_Scoring_System) only** | ||
| - Older versions: No longer recieves any patches |
There was a problem hiding this comment.
Typo: "recieves" → "receives".
📝 Proposed fix
-- Older versions: No longer recieves any patches
+- Older versions: No longer receives any patches📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - Older versions: No longer recieves any patches | |
| - Older versions: No longer receives any patches |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/releases/index.mdx` at line 31, Fix the typo in the release note
sentence that reads "Older versions: No longer recieves any patches" by changing
"recieves" to "receives" so the line reads "Older versions: No longer receives
any patches"; locate and update that exact string in the docs/releases/index.mdx
content.
Docs: Update supported versions and security patching details (cherry picked from commit 52873a9)
Clarified security patching policy for supported versions and updated example version.
Closes #
What I did
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
Caution
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook publish.yml --field pr=<PR_NUMBER>Summary by CodeRabbit