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

Indexer: Add metaTags and make autodocs inherit them #25537

Merged
merged 7 commits into from
Jan 12, 2024

Conversation

shilman
Copy link
Member

@shilman shilman commented Jan 10, 2024

Telescopes off #25328

What I did

In the current code, the Autodocs index entry inherits all the tags from the "primary" (first) story on the page it is being generated from. This results in the following weird behavior.

Suppose I have a component Foo with three stories, A, B, and C. The component's meta adds the autodocs tag, meaning that the sidebar shows "Foo > Autodocs, A, B, C". A has the tags ['a']. Then I filter the sidebar to remove everything with the tag 'a'. The story A disappears as expected, but the autodocs also disappears because it inherits all of A's tags!

This change means that the Autodocs entry only inherit's the CSF meta tags. So if the meta has tags ['m'] and I exclude 'm', it will remove Autodocs and A, B, C because the stories also inherit meta's tags. If I exclude 'a', it will only exclude A (and any other entries tagged with 'a')

NOTE: this PR doesn't fix the behavior for attached MDX pages, which currently don't inherit any tags. So that is a known corner case bug.

NOTE: this extends the Indexer API. I think this is OK because: (1) the API is still experimental, and (2) we already include metaId in the API, so this is consistent with that.

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>

Copy link
Member

@tmeasday tmeasday left a comment

Choose a reason for hiding this comment

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

Tests are great!

Maybe you should also add some test of what the behaviour is when you browse directly to a hidden story.

@shilman shilman requested a review from cdedreuille as a code owner January 11, 2024 09:47
@shilman shilman merged commit d9caeb8 into shilman/autodocs-filter Jan 12, 2024
55 of 56 checks passed
@shilman shilman deleted the shilman/add-indexer-metatags branch January 12, 2024 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants