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: Update addon-test coverage exclude details #30059

Merged
merged 3 commits into from
Dec 13, 2024

Conversation

kylegach
Copy link
Contributor

@kylegach kylegach commented Dec 13, 2024

Closes #29613

What I did

See: title

Checklist for Contributors

Testing

N/A - docs-only minor update

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.

Greptile Summary

Updates test coverage documentation to clarify how to properly exclude story files and Storybook build output from Vitest coverage reports.

  • Added exclude pattern for Storybook build output directory in code/storybook-static to coverage configuration
  • Updated Vitest version reference from 2.2.0 to 3.0.0
  • Improved readability by formatting exclude patterns on separate lines
  • Added clarification that coverage configuration must be done in user's Vitest config file

💡 (2/5) Greptile learns from your feedback when you react with 👍/👎!

@kylegach kylegach added documentation ci:docs Run the CI jobs for documentation checks only. labels Dec 13, 2024
@kylegach kylegach self-assigned this Dec 13, 2024
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.

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

Comment on lines +208 to 211
'**/*.stories.*',
// This pattern must align with the output directory of `storybook build`
'storybook-static/**',
],
Copy link
Contributor

Choose a reason for hiding this comment

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

style: Consider adding additional common story file patterns that were previously included: '/.story.', '/stories.', '**/story.'

Copy link

nx-cloud bot commented Dec 13, 2024

☁️ Nx Cloud Report

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

@kylegach kylegach merged commit 77dd851 into next Dec 13, 2024
9 checks passed
@kylegach kylegach deleted the docs-sb-test-exclude-details branch December 13, 2024 16:10
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.

[Bug]: Addon test includes stories in coverage reports
3 participants