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

Version patch from 7.6.20 #30084

Open
wants to merge 3 commits into
base: release-7-6
Choose a base branch
from

Conversation

EgorBochkarev
Copy link

@EgorBochkarev EgorBochkarev commented Dec 17, 2024

Closes #

storybookjs/test-runner#452

What I did

Checking if storyAnnotations.tags are empty, if it is, try to use componentAnnotations.tags

Checklist for Contributors

Testing

I use @storybook/test-runner and when it's run i cant see tags of a story, after fix it will be availiable

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

  1. Run story with @storybook/test-runner.
  2. Get it's context (const context = await getStoryContext(page, context);) from preVisit or postVisit hook in test-runner.ts file.
  3. Check the tags in context
  4. There aren's tags that are defined in stories meta.

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

Based on the provided files and changes, I'll create a concise summary of the PR:

Fixed story annotation tags inheritance when story tags are empty, ensuring component-level tags are properly inherited in the test runner.

  • Modified tag inheritance logic in code/lib/preview-api/src/modules/store/csf/prepareStory.ts
  • Added test case in prepareStory.test.ts to verify empty story tags behavior
  • Fixed issue where component tags weren't being used when story tags array was empty
  • Ensures 'story' tag is always appended to inherited tags
  • Maintains backward compatibility with existing tag behavior

The changes are focused on fixing a specific issue with tag inheritance in the Storybook test runner, with proper test coverage to verify the fix.

💡 (1/5) You can manually trigger the bot by mentioning @greptileai in a comment!

@EgorBochkarev EgorBochkarev changed the base branch from next to release-7-6 December 17, 2024 10:07
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.

LGTM

512 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

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.

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

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