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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

TestBuild: Add env-variable support to --test CLI-flag #24862

Merged
merged 1 commit into from Nov 16, 2023

Conversation

ndelangen
Copy link
Member

@ndelangen ndelangen commented Nov 16, 2023

What I did

For the visual testing addon I want to enable --test build-mode.

Passing the flag to the storybook CLI however sin't really straight forwards due to multiple layers of abstractions.

I don't want users to have to configure anything, so here's an sort-of-API to enable --test build-mode without setting the CLI flag: an environment variable: SB_TESTBUILD="true" will cause the --test flag to become true.

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>

@ndelangen ndelangen changed the title make CLI --test flag be true when process.env.SB_TESTBUILD === true TestBuild: Add env-variable support to --test CLI-flag Nov 16, 2023
@ndelangen ndelangen self-assigned this Nov 16, 2023
Copy link
Contributor

@kasperpeulen kasperpeulen left a comment

Choose a reason for hiding this comment

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

LGTM!

@kasperpeulen kasperpeulen merged commit 4c77249 into next Nov 16, 2023
65 of 71 checks passed
@kasperpeulen kasperpeulen deleted the norbert/test-flag-env-variable branch November 16, 2023 17:22
@github-actions github-actions bot mentioned this pull request Nov 16, 2023
36 tasks
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.

None yet

2 participants