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

Docs: Set init/upgrade snippets to latest on latest #30364

Merged
merged 1 commit into from
Jan 23, 2025

Conversation

kylegach
Copy link
Contributor

@kylegach kylegach commented Jan 23, 2025

What I did

Reverts changes in #29696, on main. Those changes only applied to next, which were then mistakenly carried over when next was copied to main in the release process.

Longer term, this situation will be fixed by https://linear.app/chromaui/issue/SB-1283/[docs]-issue-with-prereleases-and-snippet-package-labels

Checklist for Contributors

Testing

N/A - docs-only change

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-storybook/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.

Greptile Summary

Updates initialization and upgrade command documentation to use @latest instead of @next version tags in the main branch, ensuring users get the stable release version by default.

  • Modified docs/_snippets/init-command.md to use @latest for npm command: npx storybook@latest init
  • Modified docs/_snippets/init-command.md to use @latest for pnpm command: pnpm dlx storybook@latest init
  • Modified docs/_snippets/init-command.md to use @latest for yarn command: yarn dlx storybook@latest init
  • Updated corresponding upgrade commands in docs/_snippets/storybook-upgrade.md to use @latest tag

@kylegach kylegach added documentation ci:docs Run the CI jobs for documentation checks only. labels Jan 23, 2025
@kylegach kylegach self-assigned this Jan 23, 2025
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.

LGTM

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

@kylegach kylegach merged commit 15b458d into main Jan 23, 2025
7 of 14 checks passed
@kylegach kylegach deleted the doc-init-upgrade-latest branch January 23, 2025 18:28
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.

1 participant