From 2863266ebddaa87670440d687e22d865de7e4ccc Mon Sep 17 00:00:00 2001 From: Kathryn Doering Date: Wed, 14 Feb 2024 16:19:37 -0800 Subject: [PATCH] add note about orgs --- vignettes/set_up.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vignettes/set_up.Rmd b/vignettes/set_up.Rmd index 0d7753d..6546985 100644 --- a/vignettes/set_up.Rmd +++ b/vignettes/set_up.Rmd @@ -19,5 +19,5 @@ Some workflows in `{ghactions4r}` take additional setup steps besides running th 2) In the local clone, run [ghactions4r::use_calc_coverage()](https://nmfs-fish-tools.github.io/ghactions4r/reference/use_calc_coverage.html) to generate the the github action file or any other files needed. Change the build triggers if desired. 3) 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). 4) Set up an account on [codecov](https://about.codecov.io/) or [coveralls](https://coveralls.io/). For codecov, [create an account](https://docs.codecov.com/docs/github-2-getting-a-codecov-account-and-uploading-coverage#create-a-codecov-account), then install the [github app](https://docs.codecov.com/docs/github-2-getting-a-codecov-account-and-uploading-coverage#install-the-github-app-integration). For coveralls, [sign up to use OAuth through GitHub](https://coveralls.io/sign-up). -5) 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. +5) 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. 6) Optionally, display a [code coverage status badge](https://docs.codecov.com/docs/status-badges) on your repository or make a [custom codecov.yml file](https://docs.codecov.com/docs/codecovyml-reference#coverage), if desired. The [Coveralls docs](https://docs.coveralls.io/) provide more information on custom options \ No newline at end of file