Core: Namespace storybook generated tags #24839
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yannbf
requested review from
ndelangen,
tmeasday,
valentinpalkovic,
kasperpeulen,
shilman and
JReinhold
as code owners
yannbf
commented
Nov 14, 2023
| } | ||
| // the mdx-csf compiler automatically adds the 'stories-mdx' tag to meta, here' we're just making sure it is always there | ||
| if (!tags.includes('stories-mdx')) { | ||
| tags.push('stories-mdx'); | ||
| if (!tags.includes('sb:stories-mdx')) { |
There was a problem hiding this comment.
Seems like the mdx-csf compiler might need changes as well
There was a problem hiding this comment.
Yes. And docs-mdx also possibly
yannbf
commented
Nov 14, 2023
| export const STORIES_MDX_TAG = 'stories-mdx'; | ||
| export const STORIES_MDX_TAG = 'sb:stories-mdx'; | ||
| export const STORY_TAG = 'sb:story'; | ||
| export const DOCS_TAG = 'sb:docs'; |
There was a problem hiding this comment.
If we want to make this manageable, we need to move these tags to a constant that could be shared between other packages. Not sure where
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #
What I did
This is an attempt to standardize story tags, namespacing them with
sbso they can't clash with user defined tags.This PR is incomplete, it serves as a conversation starter
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>