Bump codecov/codecov-action to v2 #18
Merged
Conversation
This file contains hidden or 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
The "libraries/report-size-deltas workflow" GitHub Actions workflow prints a code coverage report to the workflow run logs. Previously this was done in the same step used to run the tests. Both the test run output and the coverage report will be easier to read with a dedicated section of the logs for each, which each workflow step has. This will also make it easier to interpret any workflow failures since the failed step would only be concerned with a single specific operation.
The v1 version of the `codecov/codecov-action` action automatically generated the data file via `coverage xml`, but the latest v2 does not, which causes it to fail: ``` [2022-01-05T09:53:02.481Z] ['info'] Searching for coverage files... [2022-01-05T09:53:02.501Z] ['error'] There was an error running the uploader: Error while cleaning paths. No paths matched existing files! Error: Codecov: Failed to properly upload: The process '/home/runner/work/_actions/codecov/codecov-action/v2.1.0/dist/codecov' failed with exit code 255 ``` It also seems better to have full control over the process by doing it explicitly rather than relying on an action which is used primarily to handle the data upload to Codecov.
The `codecov/codecov-action` GitHub Actions action is used in the "libraries/report-size-deltas workflow" workflow to upload code coverage data to Codecov. The previously used `codecov/codecov-action@v1` version is deprecated and will cease working in less than a month: https://github.com/codecov/codecov-action#%EF%B8%8F--deprecration-of-v1 The use of the `v2` major version ref will cause the workflow to use a stable version of the action, while also benefiting from ongoing development to the action up until such time as a new major release of an action is made. At that time we would need to evaluate whether any changes to the workflow are required by the breaking change that triggered the major release before manually updating the major ref (e.g., uses: `codecov/codecov-action@v3`).
per1234
added
type: enhancement
giulcioffi
approved these changes
Jan 10, 2022
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.
The
codecov/codecov-actionGitHub Actions action is used in the "libraries/report-size-deltas workflow" workflow to upload code coverage data to Codecov.The previously used
codecov/codecov-action@v1version is deprecated and will cease working in less than a month:https://github.com/codecov/codecov-action#%EF%B8%8F--deprecration-of-v1
The use of the
v2major version ref will cause the workflow to use a stable version of the action, while also benefiting from ongoing development to the action up until such time as a new major release of an action is made. At that time we would need to evaluate whether any changes to the workflow are required by the breaking change that triggered the major release before manually updating the major ref (e.g., uses:codecov/codecov-action@v3).The v1 version of the
codecov/codecov-actionaction automatically generated the data file viacoverage xml, but thelatest v2 does not, which causes it to fail:
It also seems better to have full control over the process by doing it explicitly rather than relying on an action which
is used primarily to handle the data upload to Codecov.
This also more closely aligns the workflow with the one for the
arduino/compile-sketchesaction.Supersedes #17