RHOAIENG-11142: chore(test): Integrate Codecov coverage reporting for odh-notebook-controller #492
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…controller This commit integrates Codecov into our testing process by publishing our coverage report generated during `make test` to Codecov via the official `codecov/codecov-action` GHA. The `CODECOV_TOKEN` was previously uploaded to our GH repository as a secret (and copied to the Dependabot Secrets as well) by a repo admin: - https://redhat-internal.slack.com/archives/C060A5FJEAD/p1733334721701649 Please be aware of functionality **NOT** included in this initial PR (that may be added in the future): - unit test results are not being shipped to `Codecov` (even though that capability is supported) - a `.codecov.yml` file is presently not included. this could come as a fast-follow after the team gets a "feel" for `Codecov` - but I think its a bit premature to take my personal opinions to create such a file. Example `odh-dashboard` config can be seen here: - https://github.com/opendatahub-io/odh-dashboard/blob/main/.codecov.yml The `Codecov` integration was added to the `odh_notebook_controller_unit_test.yaml` GHA - which is already configured to execute on `pull_request` and `push` triggers. As such, no additional modification was necessary. :warning: It should be noted that the `make test` target was modifed to ensure the coverage files for the 2 respective invocations of `go test` wrote to unique output files to prevent information loss. `*.out` files are already ignored via `.gitignore`, so no problems there. Also, Codecov claims to support report merging automatically - so this should cause no issues: - https://docs.codecov.com/docs/merging-reports Related-to: https://issues.redhat.com/browse/RHOAIENG-11142
|
/label tide/merge-method-squash i like this one, because for these small PRs it will skip creating a merge commit and keeps git history a bit simpler this way |
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered ☂️ |
|
/lgtm |
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED Approval requirements bypassed by manually added approval. This pull-request has been approved by: The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
0ed5904
into
opendatahub-io:main
12 checks passed
jiridanek
pushed a commit
to jiridanek/kubeflow
that referenced
this pull request
Jan 23, 2025
…controller (opendatahub-io#492) This commit integrates Codecov into our testing process by publishing our coverage report generated during `make test` to Codecov via the official `codecov/codecov-action` GHA. The `CODECOV_TOKEN` was previously uploaded to our GH repository as a secret (and copied to the Dependabot Secrets as well) by a repo admin: - https://redhat-internal.slack.com/archives/C060A5FJEAD/p1733334721701649 Please be aware of functionality **NOT** included in this initial PR (that may be added in the future): - unit test results are not being shipped to `Codecov` (even though that capability is supported) - a `.codecov.yml` file is presently not included. this could come as a fast-follow after the team gets a "feel" for `Codecov` - but I think its a bit premature to take my personal opinions to create such a file. Example `odh-dashboard` config can be seen here: - https://github.com/opendatahub-io/odh-dashboard/blob/main/.codecov.yml The `Codecov` integration was added to the `odh_notebook_controller_unit_test.yaml` GHA - which is already configured to execute on `pull_request` and `push` triggers. As such, no additional modification was necessary. :warning: It should be noted that the `make test` target was modifed to ensure the coverage files for the 2 respective invocations of `go test` wrote to unique output files to prevent information loss. `*.out` files are already ignored via `.gitignore`, so no problems there. Also, Codecov claims to support report merging automatically - so this should cause no issues: - https://docs.codecov.com/docs/merging-reports Related-to: https://issues.redhat.com/browse/RHOAIENG-11142
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This commit integrates Codecov into our testing process by publishing our coverage report generated during
make testto Codecov via the officialcodecov/codecov-actionGHA.The
CODECOV_TOKENwas previously uploaded to our GH repository as a secret (and copied to the Dependabot Secrets as well) by a repo admin:Please be aware of functionality NOT included in this initial PR (that may be added in the future):
Codecov(even though that capability is supported).codecov.ymlfile is presently not included. this could come as a fast-follow after the team gets a "feel" forCodecov- but I think its a bit premature to take my personal opinions to create such a file. Exampleodh-dashboardconfig can be seen here:The
Codecovintegration was added to theodh_notebook_controller_unit_test.yamlGHA - which is already configured to execute onpull_requestandpushtriggers. As such, no additional modification was necessary.make testtarget was modifed to ensure the coverage files for the 2 respective invocations ofgo testwrote to unique output files to prevent information loss.*.outfiles are already ignored via.gitignore, so no problems there. Also, Codecov claims to support report merging automatically - so this should cause no issues:Related-to: https://issues.redhat.com/browse/RHOAIENG-11142
How Has This Been Tested?
Testing of the
codecov/codecov-actionGHA was performed against a repo in my personal organization:Observations and outcomes were reported in Slack:
make testwas ran locally to ensure renaming output files didn't introduce any regressionsMerge criteria: