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: Short documentation change from latest to 7 in command #28678

Merged
merged 5 commits into from
Jul 29, 2024

Conversation

aminghs
Copy link
Contributor

@aminghs aminghs commented Jul 23, 2024

What I did

I have changed the command since based on the title, we have to upgrade version 6 to 7, not latest.

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

Changes are in md file.

Documentation

  • Add or update documentation reflecting your changes
  • @[x] 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>

Amin Ghs added 2 commits July 23, 2024 09:58
Since we want to upgrade to version 7, we need to use 7 in command instead of latest
Since we need to update 6 to 7, the command should be 7 instead of latest
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.

PR Summary

Updated the MIGRATION.md file to change the Storybook CLI command from 'latest' to '7', ensuring precise version-specific upgrades.

  • Modified MIGRATION.md to use storybook@7 instead of storybook@latest for CLI commands.
  • Ensures users upgrading from version 6 to 7 use the correct command, avoiding potential issues with future versions.

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

@valentinpalkovic valentinpalkovic added documentation ci:docs Run the CI jobs for documentation checks only. labels Jul 29, 2024
@valentinpalkovic valentinpalkovic changed the title Short documentation change from latest to 7 in command Docs: Short documentation change from latest to 7 in command Jul 29, 2024
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.

@aminghs thanks for taking the time to put together this pull request and helping us improve the documentation by catching this small item. We appreciate it 🙏 ! I left a small item for you to look into when you have a moment.

Let me know once you've addressed and I'll gladly take another look.

Have a fantastic week.

Stay safe

MIGRATION.md Outdated Show resolved Hide resolved
Copy link

nx-cloud bot commented Jul 29, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 165df9d. 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.

@jonniebigodes
Copy link
Contributor

@aminghs, thank you for addressing the feedback so promptly. I appreciate it 🙏 ! All is good on my end. I'm going to merge this once the checklist clears.

@jonniebigodes jonniebigodes merged commit 84a2b96 into storybookjs:next Jul 29, 2024
8 checks passed
@aminghs aminghs deleted the change-latest-to-7-in-command branch July 29, 2024 16:31
@github-actions github-actions bot mentioned this pull request Jul 31, 2024
14 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.

3 participants