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: Add usage information and coverage report to docs #8

Merged
merged 3 commits into from
Nov 24, 2023

Conversation

kevintyj
Copy link
Owner

What is the purpose of this PR?

Add usage information and coverage report to docs. This will help users better utilize the action.

ClickUp/Jira/Github project ticket number(s)?

What did you do?

Add Vitest coverage report to CI pipeline
Reach 100% coverage
Add codecov to CI & repository
Fix ignore patterns for test reports

How do we test it?

Vitest test suites all passing

Checklist before merging

  • Added tests where necessary
  • Performed a self-review of my code
  • Ensure all acceptance criteria are met
  • Implemented the UI as exactly as the design (applicable only for UI changes)
  • Added comments for codes where hard-to-understand
  • Haven't pushed unnecessary files (ex: .env, .map)
  • Haven't ignored Typescript warnings in the code (if do so add a comment with the reason)

Provide screenshot details of the PR

[optional] Tests passed screenshot

[optional] Breaking changes after PR

Anything else?

Repository owner deleted a comment from codecov bot Nov 24, 2023
Copy link

codecov bot commented Nov 24, 2023

Welcome to Codecov 🎉

Once merged to your default branch, Codecov will compare your coverage reports and display the results in this comment.

Thanks for integrating Codecov - We've got you covered ☂️

@kevintyj kevintyj merged commit ca33b8f into main Nov 24, 2023
4 checks passed
@kevintyj kevintyj deleted the docs/coverage branch November 24, 2023 20:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant