Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: How to release changes to older minors #29534

Merged
merged 4 commits into from
Nov 5, 2024

Conversation

JReinhold
Copy link
Contributor

@JReinhold JReinhold commented Nov 4, 2024

What I did

Added a section to RELEASING.md on how to make changes to older minors, eg. releasing critical bugfixes.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make 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/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Greptile Summary

Let me provide a clear and concise summary of this documentation-focused PR:

Added comprehensive documentation for releasing patches to older minor versions of Storybook, detailing the manual release process when the latest version isn't the target.

  • Added new section "Releasing changes to older minor versions" in CONTRIBUTING/RELEASING.md
  • Provided step-by-step instructions for manually releasing patches (e.g. v8.3.7 when 8.4.0 is current)
  • Included critical details about npm permissions, version tagging, and CI workflow
  • Documented changelog synchronization between branches for version tracking
  • Added guidance for creating GitHub releases for older versions

This documentation fills an important gap in the release process documentation, helping maintainers handle critical backported fixes.

@JReinhold JReinhold self-assigned this Nov 4, 2024
@JReinhold JReinhold added documentation ci:docs Run the CI jobs for documentation checks only. labels Nov 4, 2024
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile

CONTRIBUTING/RELEASING.md Outdated Show resolved Hide resolved
Copy link

nx-cloud bot commented Nov 4, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 27191fd. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JReinhold thanks for taking the time to put together this pull request and help with the documentation. Appreciate it 🙏 ! I left some items for you to look into when you can.

Let me know, and we'll go from there.

CONTRIBUTING/RELEASING.md Outdated Show resolved Hide resolved
CONTRIBUTING/RELEASING.md Outdated Show resolved Hide resolved
CONTRIBUTING/RELEASING.md Outdated Show resolved Hide resolved
CONTRIBUTING/RELEASING.md Outdated Show resolved Hide resolved
CONTRIBUTING/RELEASING.md Outdated Show resolved Hide resolved
@JReinhold JReinhold merged commit 860e63e into next Nov 5, 2024
6 checks passed
@JReinhold JReinhold deleted the jeppe/document-backporting branch November 5, 2024 20:30
@github-actions github-actions bot mentioned this pull request Nov 11, 2024
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs Run the CI jobs for documentation checks only. documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants