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 minor fixes #24645

Merged
merged 7 commits into from
Nov 20, 2023
Merged

Docs: Test runner minor fixes #24645

merged 7 commits into from
Nov 20, 2023

Conversation

jonniebigodes
Copy link
Contributor

Follows up on test runner's #373

What I did

With this pull request, the test runner's documentation was updated to factor in the test runner's API hooks changes, as they're no longer experimental and potentially haven't been for quite some time.

What was done:

  • Updated docs and snippets

@yannbf when you have a moment, can you take a pass at this and let me know of any feedback, specifically the usage of module.exports in the snippets? If you're ok with it we can update them to align with the rest of the documentation.

Let me know, and we'll take it from there. 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 ci:docs Run the CI jobs for documentation checks only. labels Oct 31, 2023
@jonniebigodes jonniebigodes requested a review from yannbf October 31, 2023 23:50
@jonniebigodes jonniebigodes self-assigned this Oct 31, 2023
@jonniebigodes jonniebigodes requested a review from yannbf November 17, 2023 10:53
@jonniebigodes
Copy link
Contributor Author

@yannbf thanks for feedback and context on this. Appreciate it 🙏 ! I've just pushed some updates to this pull request. Let me know if you have any additional feedback and we'll take it from there.

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.

looks great!! Thanks for working on the feedback!

@jonniebigodes jonniebigodes merged commit 0b50467 into next Nov 20, 2023
18 checks passed
@jonniebigodes jonniebigodes deleted the docs_test_runner_updates branch November 20, 2023 18:31
@github-actions github-actions bot mentioned this pull request Nov 20, 2023
36 tasks
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants