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: Document CLI version support #25658

Merged
merged 1 commit into from
Jan 25, 2024
Merged

Docs: Document CLI version support #25658

merged 1 commit into from
Jan 25, 2024

Conversation

kylegach
Copy link
Contributor

@kylegach kylegach commented Jan 18, 2024

What I did

Document CLI version support.

Checklist for Contributors

Testing

Manual testing

  1. Follow the steps in the contributing instructions for this branch, docs-cli-versioning

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>

@kylegach kylegach added documentation ci:docs Run the CI jobs for documentation checks only. labels Jan 18, 2024
@kylegach kylegach self-assigned this Jan 18, 2024
@kylegach
Copy link
Contributor Author

@JReinhold — Should this be patched? I saw some notes that the functionality works in 7.6, but wasn't confident in that.

Copy link
Contributor

@JReinhold JReinhold left a comment

Choose a reason for hiding this comment

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

Looks good! Just one line we need to change, but I'm sure you'll figure it out.

docs/configure/upgrading.md Outdated Show resolved Hide resolved
@JReinhold
Copy link
Contributor

Yes, this should be patched @kylegach, it's available in v7.6.9 and onwards.

@kylegach kylegach changed the base branch from next to docs_adds_doctor January 18, 2024 21:07
@kylegach kylegach added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Jan 18, 2024
Base automatically changed from docs_adds_doctor to next January 22, 2024 10:46
@kylegach kylegach force-pushed the docs-cli-versioning branch 2 times, most recently from 49ab243 to f4b084d Compare January 22, 2024 17:39
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.

Thanks for taking the time to adjust the documentation and add in the versioning changes. Appreciate it 🙏 ! All is good on my end. Merge when able

@kylegach kylegach merged commit 7bbf75f into next Jan 25, 2024
18 checks passed
@kylegach kylegach deleted the docs-cli-versioning branch January 25, 2024 17:44
JReinhold pushed a commit that referenced this pull request Jan 31, 2024
Docs: Document CLI version support
(cherry picked from commit 7bbf75f)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jan 31, 2024
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 patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants