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

Docs: Test runner add missing flag to the CLI options #27350

Merged
merged 2 commits into from
May 24, 2024

Conversation

jonniebigodes
Copy link
Contributor

Follows up on #409

What I did

With this small pull request, the documentation was updated to factor in the change (i.e., the flag) introduced in the mentioned pull request.

What was done:

  • Adjusted the existing CLI options in the test runner documentation to factor in the flag.

@yannbf, when you have a moment, can you take a look into this pull request and let me know of any feedback you may have. Thanks in advance.

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>

@jonniebigodes jonniebigodes added documentation patch:yes Bugfix & documentation PR that need to be picked to main branch ci:docs Run the CI jobs for documentation checks only. labels May 23, 2024
@jonniebigodes jonniebigodes requested a review from yannbf May 23, 2024 20:20
@jonniebigodes jonniebigodes self-assigned this May 23, 2024
Copy link

nx-cloud bot commented May 23, 2024

☁️ Nx Cloud Report

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

Copy link
Member

@yannbf yannbf left a comment

Choose a reason for hiding this comment

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

LGTM! Sorry I missed updating the docs here!

@jonniebigodes
Copy link
Contributor Author

No worries, we caught it on time. Going to merge this once the checklist clears. Appreciate you taking a look 🙏

@jonniebigodes jonniebigodes merged commit 02b7619 into next May 24, 2024
17 checks passed
@jonniebigodes jonniebigodes deleted the docs_test_runner_timeout_option branch May 24, 2024 13:53
storybook-bot pushed a commit that referenced this pull request May 24, 2024
…ption

Docs: Test runner add missing flag to the CLI options
(cherry picked from commit 02b7619)
storybook-bot pushed a commit that referenced this pull request May 24, 2024
…ption

Docs: Test runner add missing flag to the CLI options
(cherry picked from commit 02b7619)
storybook-bot pushed a commit that referenced this pull request May 27, 2024
…ption

Docs: Test runner add missing flag to the CLI options
(cherry picked from commit 02b7619)
storybook-bot pushed a commit that referenced this pull request May 27, 2024
…ption

Docs: Test runner add missing flag to the CLI options
(cherry picked from commit 02b7619)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label May 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs Run the CI jobs for documentation checks only. documentation patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants