CLI: Don't add @storybook/addon-links by default
#29177
Conversation
☁️ Nx Cloud ReportCI is running/has finished running commands for commit dab6fd9. 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 targetSent with 💌 from NxCloud. |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
LGTM
16 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings
|
Thanks for this! You're actually touching upon something that we've discussed recently, except you're taking it in the opposite direction 😅
If you change up this PR to remove it from default addons and not add it to |
|
Removing it from the default generator is an option as well 😄 I've done just that now. It may be the case that it now has be added to the sandbox. Not sure how/where to do this best though. |
tobiasdiez
changed the title
|
Nice!
I think you can add it by concating https://github.com/storybookjs/storybook/blob/next/scripts/tasks/sandbox-parts.ts/#L178 |
There was a problem hiding this comment.
@tobiasdiez, thank you for taking the time to put together this pull request and help with the documentation. I appreciate it 🙏 ! From my end (docs-wise), everything is good. I'm going to approve this, but I'll defer to the rest of the team for their input.
Hope you have a great day.
Stay safe
|
@JReinhold Thanks, but it seems this is actually not required (at least the test pass). @jonniebigodes Thanks for the review! |
I see. 🤔 This might be because we add resolutions for it too. |
JReinhold
changed the title
@storybook/addon-links by default
shilman
changed the title
@storybook/addon-links by default@storybook/addon-links by default
Closes #29073
What I did
The link addon is installed by default when initializing storybook using the cli. Thus, I think, it make sense to make it part of "@storybook/essential-addons". One less package whose version has to be synchronized with the main storybook version and makes manual installation a bit simpler as well.
But maybe there was a reason why it was not essential...sorry if I might reopen an old discussion, this was not my intention.
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.tsMake 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/coreteam 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>Greptile Summary
This PR marks the link addon as essential by incorporating it into the @storybook/addon-essentials package. Key changes include:
These changes streamline Storybook setup by including the link addon by default, reducing manual configuration and version synchronization needs.