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

Addon Test: Error when addon interactions exists #29338

Merged
merged 5 commits into from
Oct 23, 2024

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Oct 11, 2024

Closes #

What I did

This PR introduces a preset annotation to addon test to check if addon interactions exists, and if it does, it will throw an error.

it also fixes the entry check for addon actions order, which wasn't working before.

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>

Greptile Summary

This PR introduces a conflict detection mechanism between the Storybook addon-interactions and addon-test, ensuring they are not used simultaneously.

  • Added ADDON_INTERACTIONS_IN_USE constant in code/addons/interactions/src/preset.ts to indicate addon-interactions usage
  • Implemented conflict check in code/addons/test/src/preset.ts, throwing an error if both addons are enabled
  • Fixed entry check for addon actions order in code/addons/test/src/preset.ts
  • Added previewAnnotations and managerEntries exports in code/addons/test/src/preset.ts for improved addon management

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, 1 comment(s)
Edit PR Review Bot Settings | Greptile

Comment on lines +61 to +135
// for whatever reason seems like the return type of managerEntries is not correct (it expects never instead of string[])
return entry as never;
Copy link
Contributor

Choose a reason for hiding this comment

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

style: casting entry to never may hide type issues

Copy link

nx-cloud bot commented Oct 11, 2024

☁️ Nx Cloud Report

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

@yannbf yannbf force-pushed the yann/addon-interactions-conflict branch from 46f140f to 0e572bc Compare October 14, 2024 10:30
@valentinpalkovic valentinpalkovic merged commit 0959d02 into unified-ui-testing Oct 23, 2024
22 of 24 checks passed
@valentinpalkovic valentinpalkovic deleted the yann/addon-interactions-conflict branch October 23, 2024 12:51
@valentinpalkovic valentinpalkovic restored the yann/addon-interactions-conflict branch October 23, 2024 14:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants