nmfs-fish-tools / ghactions4r

Reusable github actions workflows for R packages
https://nmfs-fish-tools.github.io/ghactions4r/
12 stars 1 forks source link

[Feature]: vignettes showing codecov, packagedown setups #108

Closed k-doering-NOAA closed 6 months ago

k-doering-NOAA commented 8 months ago

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

It isn't immediately clear on the steps needed to set up code coverage or pkg down from the docuementation currently available.

Describe the solution you would like.

Add additional documentation that describes steps the users need to take to set up these workflows

Describe alternatives you have considered

Reference documentation from elsewhere

Additional context

No response

k-doering-NOAA commented 8 months ago

For code coverage, I think the steps are:

1) On a local clone of your git repository, Run ghactions4r::use_calc_coverage() to generate the the github action file or any other files needed. Change the build triggers if desired. 2) 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). 3) Set up an account on codecov or coveralls (I've only used codecov). For codecov, create an account, then install the github app. 5) Try re-running the code coverage github action by pushing a new commit and see if your results go to codecov/coveralls. 6) Optionally, display a code coverage status badge on your repository or make a custom codecov.yml file, if desired.

I tested these steps by setting up calc cov on the ghactions4r repo

k-doering-NOAA commented 8 months ago

Note this overlaps with #9

k-doering-NOAA commented 6 months ago

closing, as codecov vignette is complete, and pkgdown issue is documented in #9.