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

CLI: Add main.js docs.autodocs automigration #27089

Merged
merged 3 commits into from
May 10, 2024

Conversation

shilman
Copy link
Member

@shilman shilman commented May 10, 2024

Closes #27078

What I did

Instead of checking the user's main.js file at runtime to log a deprecation message, just add an automigration that runs at upgrade time.

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

Run storybook automigrate autodocs-tags in a storybook with:

  • docs.autodocs = true
  • docs.autodocs = true and no preview.js file
  • docs.autodocs = false
  • docs.autodocs = 'tag'

Verify that the migration makes sense and that the messages are useful.

Documentation

N/A

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>

@shilman shilman added maintenance User-facing maintenance tasks cli labels May 10, 2024
Copy link

nx-cloud bot commented May 10, 2024

☁️ Nx Cloud Report

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

@yannbf
Copy link
Member

yannbf commented May 10, 2024

Some cleanup is needed:

src/modules/store/csf/prepareStory.ts(2,1): error TS6133: 'dedent' is declared but its value is never read.
src/modules/store/csf/prepareStory.ts(26,1): error TS6133: 'once' is declared but its value is never read.

Copy link
Member

@yannbf yannbf left a comment

Choose a reason for hiding this comment

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

Looks fine to me, did not test

@shilman shilman merged commit 7c43348 into next May 10, 2024
61 checks passed
@shilman shilman deleted the shilman/add-docs-autodocs-automigration branch May 10, 2024 16:45
@github-actions github-actions bot mentioned this pull request May 13, 2024
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:normal cli maintenance User-facing maintenance tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: "The docs.autodocs setting in '.storybook/main.js' is deprecated." Appears even after migrating
2 participants