Some workflows in {ghactions4r} take additional setup
steps besides running the use_* function. Here is a guide
on the additional steps to be taken.
Setting up code coverage for your R package
- Clone your R package locally.
- In the local clone, run ghactions4r::use_calc_coverage()
to generate the the github action file or any other files needed. Change
the build triggers if desired.
- Commit the files and push them up to GitHub. See if a github action
runs. If it does not, try pushing to your main branch to trigger a run,
if your build triggers include a run on pushing to the main branch (the
default).
- Set up an account on codecov
or coveralls. For codecov, create
an account, then install the github
app. For coveralls, sign up
to use OAuth through GitHub.
- Try re-running your Code Coverage GitHub Action by pushing a new
commit and see if your results go to the Codecov or Coveralls website.
Note that if your tool is in an organization that is already using
Codecov or Coveralls, you may not need to make an account.
- Optionally, display a code coverage status
badge on your repository or make a custom
codecov.yml file, if desired. The Coveralls docs provide more
information on custom options