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

[Feature] Script for Coverage Check #22

Open
1 of 3 tasks
vaguecoder opened this issue Jan 6, 2023 · 4 comments
Open
1 of 3 tasks

[Feature] Script for Coverage Check #22

vaguecoder opened this issue Jan 6, 2023 · 4 comments
Assignees
Labels
code-quality Improve code quality dev-exp Developer experience feature Feature request is when an idea for completely new feature is submitted good first issue Good for newcomers help wanted Extra attention is needed shell Shell related code changes (required/expected) todo Has TODOs to create indicidual issues from

Comments

@vaguecoder
Copy link
Owner

Is your feature request related to a problem? Please describe.

Currently, we only check coverage in local run with manual validation. Need to automate for CI/CD.

Describe the solution you'd like

Need a script that will fail if the expected threshold is not met. This can then be run from GitHub actions on every push or PR.

Describe alternatives you've considered

Make target would also do the trick. But as the commands grow in size, it gets a hassle to overload makefile.

Additional context

  1. GitHub actions already have the unit test run workflow(s). Just need to add a separate workflow of coverage check.
  2. If using a script, it should run on bash (zsh user myself, I still think bash is the standard). Syntax differences of different shells or WSL is a headache of the future developers.

Ownership of Contribution

If the triage is approved,

  • I wish to submit the PR myself.
  • I wish to submit the PR. But if someone is willing to do it, go ahead.
  • I don't know how to fix this or make these changes. I wish others to pick this up for me.
@vaguecoder vaguecoder added help wanted Extra attention is needed good first issue Good for newcomers triage An primary assessment is required before go ahead feature Feature request is when an idea for completely new feature is submitted shell Shell related code changes (required/expected) and removed triage An primary assessment is required before go ahead labels Jan 6, 2023
@tanryberdi
Copy link

@assign

@vaguecoder vaguecoder added dev-exp Developer experience code-quality Improve code quality todo Has TODOs to create indicidual issues from labels Jan 11, 2023
@tanryberdi
Copy link

@vaguecoder what is the minimum (%) for test coverage in that task?

@vaguecoder
Copy link
Owner Author

@tanryberdi Let's mark the current code coverage as the minimum. Because the ultimate aim is to maintain & keep it improving.

tanryberdi added a commit to tanryberdi/gorilla-mux that referenced this issue Jan 19, 2023
- Added script for CI for test coverage

See vaguecoder#22
tanryberdi added a commit to tanryberdi/gorilla-mux that referenced this issue Jan 19, 2023
- Added script for CI for test coverage
Signed-off-by: Tanryberdu <[email protected]>

See vaguecoder#22
tanryberdi added a commit to tanryberdi/gorilla-mux that referenced this issue Jan 19, 2023
- Added script for CI for test coverage
Signed-off-by: Tanryberdi <[email protected]>

See vaguecoder#22
tanryberdi added a commit to tanryberdi/gorilla-mux that referenced this issue Jan 19, 2023
- Added script for CI for test coverage
Signed-off-by: Tanryberdi <[email protected]>

See vaguecoder#22
@tanryberdi
Copy link

@vaguecoder could you please take a look? for now I put minimum coverage as 75%

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code-quality Improve code quality dev-exp Developer experience feature Feature request is when an idea for completely new feature is submitted good first issue Good for newcomers help wanted Extra attention is needed shell Shell related code changes (required/expected) todo Has TODOs to create indicidual issues from
Projects
None yet
Development

No branches or pull requests

2 participants