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

Manager: Add tags property to GroupEntry objects #29672

Open
wants to merge 3 commits into
base: next
Choose a base branch
from

Conversation

Sidnioulz
Copy link
Contributor

@Sidnioulz Sidnioulz commented Nov 20, 2024

What I did

I edited the code converting the story index to story hashes for use in the manager (transformStoryIndexToStoriesHash), to add a tags property for 'group' entries, which is the intersection of all their stories' hashes.

This is the 'group' counterpart of #29343. I am opening the PR because users of my addon have come to me requesting support for badges in group entries of the sidebar, which requires that tags are also computed for these: Sidnioulz/storybook-addon-tag-badges#20.

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!

  • Add a sidebar renderLabel function that prints all tags
  • Notice the presence of 'dev', 'vitest', etc. tags in group entries in the storybook:ui instance

Documentation

Still not sure how/where to document this, like I pointed out in the component PR.

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-storybook/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>

Greptile Summary

Added support for tags in GroupEntry objects within the Storybook manager's sidebar, computing them as the intersection of child stories' tags.

  • Added tags property to API_GroupEntry interface in code/core/src/types/modules/api-stories.ts
  • Enhanced intersect utility in code/core/src/manager-api/lib/intersect.ts with stricter array validation
  • Modified transformStoryIndexToStoriesHash in code/core/src/manager-api/lib/stories.ts to compute group entry tags
  • Added unit tests in code/core/src/manager-api/tests/stories.test.ts verifying tag inheritance for group entries

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

4 file(s) reviewed, 2 comment(s)
Edit PR Review Bot Settings | Greptile

code/core/src/manager-api/lib/intersect.ts Outdated Show resolved Hide resolved
code/core/src/manager-api/lib/stories.ts Show resolved Hide resolved
Copy link

nx-cloud bot commented Nov 20, 2024

☁️ Nx Cloud Report

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant