Skip to content

Commit

Permalink
add gh actions content to conventions chapter
Browse files Browse the repository at this point in the history
  • Loading branch information
sckott committed Mar 14, 2024
1 parent 4fdde5d commit f842545
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions conventions.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,13 @@ We strongly encourage all repositories that are R or Python packages or research

- R: [reprex](https://www.tidyverse.org/help/#reprex)
- Python: [reprexlite](https://pypi.org/project/reprexlite/), [reprexpy](https://pypi.org/project/reprexpy/)

### GitHub Actions

(For brevity we'll use the shorthand "GH actions")

- R: The `usethis` function [use_github_actions](https://usethis.r-lib.org/reference/use_github_action.html) can be used to add many different GH actions, e.g., `use_github_action("pkgdown")`. For R packages, we recommend using the following three:
- `use_github_action("check-standard")`
- `use_github_action("lint")`
- `use_github_action("pkgdown")`
- Python: There is no tool available for Python similar to `usethis` - one has to manually add workflow files. For Python packages we recommend following GitHub's guide on [Building and Testing Python](https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python). As there are many different ways to make and maintain Python packages, you will need to decide what steps are needed for your package.

0 comments on commit f842545

Please sign in to comment.