Conversation
Contributor
|
Updated repo README file. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
It is good practice to include test coverage in the package README. The approach I was familiar with included a github workflow like this: https://github.com/r-lib/actions/blob/v2-branch/examples/test-coverage.yaml. The workflow is triggered for PRs and my understanding is that the runner calculates test coverage, uploads the coverage report to codecov and then the badge is retrieved from codecov. However, for this to work we need to integrate GitHub with codecov. This is probably fine but I don't think this is necessary.
This PR replaces test-coverage.yaml with update-readme.yaml. The new workflow requests the runner to rebuild the readme. If the readme has changed, the runner will commit it to the PR. If not, the runner posts a message to the PR that the readme is up to date. This way coverage still gets recalculated automatically at each PR. Let's see if it works :)