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: add migrate and automigrate to the CLI Options page #26724

Merged
merged 7 commits into from
Apr 4, 2024

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Apr 3, 2024

Closes #

What I did

This PR adds documentation about the migrate and automigrate commands in the CLI Options page, as well as adds the missing flags from the other CLI commands.

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>

@yannbf yannbf added documentation cli patch:yes Bugfix & documentation PR that need to be picked to main branch ci:docs Run the CI jobs for documentation checks only. labels Apr 3, 2024
@yannbf yannbf requested a review from jonniebigodes April 3, 2024 12:15
Copy link
Contributor

github-actions bot commented Apr 3, 2024

Fails
🚫 PR title must be in the format of "Area: Summary", With both Area and Summary starting with a capital letter Good examples: - "Docs: Describe Canvas Doc Block" - "Svelte: Support Svelte v4" Bad examples: - "add new api docs" - "fix: Svelte 4 support" - "Vue: improve docs"

Generated by 🚫 dangerJS against 928eed4

Copy link

nx-cloud bot commented Apr 3, 2024

☁️ Nx Cloud Report

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

@yannbf appreciate you taking the time to put together this pull request and help extend the documentation by adding these options. I left some items for you to look into when you have the chance.

Let me know once you've addressed the feedback, so that we can get this merge and published into the documentation.

docs/api/cli-options.md Outdated Show resolved Hide resolved
docs/api/cli-options.md Outdated Show resolved Hide resolved
docs/api/cli-options.md Outdated Show resolved Hide resolved
docs/api/cli-options.md Outdated Show resolved Hide resolved
docs/api/cli-options.md Outdated Show resolved Hide resolved
docs/api/cli-options.md Outdated Show resolved Hide resolved
docs/api/cli-options.md Outdated Show resolved Hide resolved
docs/api/cli-options.md Outdated Show resolved Hide resolved
docs/api/cli-options.md Outdated Show resolved Hide resolved
docs/api/cli-options.md Outdated Show resolved Hide resolved
@jonniebigodes jonniebigodes changed the title Documentation: add migrate and automigrate to the CLI Options page Docs: add migrate and automigrate to the CLI Options page Apr 3, 2024
@yannbf yannbf force-pushed the yann/document-cli-flags branch from 0223935 to d77f72e Compare April 4, 2024 07:22
@jonniebigodes
Copy link
Contributor

@yannbf I just pushed a commit with some minor adjustments so that the wording matched in the same options (e.g., dev, build) and removed one small comment that was left from a previous update. I've checked this locally, and everything is good. And appreciate you taking the time to make these adjustments. Once the checklist clears, I'll get it merged.

@jonniebigodes jonniebigodes merged commit 0943cd4 into next Apr 4, 2024
16 of 17 checks passed
@jonniebigodes jonniebigodes deleted the yann/document-cli-flags branch April 4, 2024 17:50
storybook-bot pushed a commit that referenced this pull request Apr 4, 2024
Docs: add migrate and automigrate to the CLI Options page
(cherry picked from commit 0943cd4)
storybook-bot pushed a commit that referenced this pull request Apr 5, 2024
Docs: add migrate and automigrate to the CLI Options page
(cherry picked from commit 0943cd4)
storybook-bot pushed a commit that referenced this pull request Apr 5, 2024
Docs: add migrate and automigrate to the CLI Options page
(cherry picked from commit 0943cd4)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Apr 5, 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. cli 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.

2 participants