doc: update from Rachel's comments #415
Workflow file for this run
This file contains 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
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples | |
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help | |
# | |
# Modifications: | |
# - devtools::build_readme() | |
# - workflow_dispatch added to allow manual triggering of the workflow | |
# - trigger branches changed | |
# - API key secrets.DELPHI_GITHUB_ACTIONS_EPIDATA_API_KEY | |
on: | |
push: | |
paths: ["R/**", "README.Rmd"] | |
workflow_dispatch: | |
name: Document | |
jobs: | |
document: | |
runs-on: ubuntu-latest | |
env: | |
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} | |
DELPHI_EPIDATA_KEY: ${{ secrets.DELPHI_GITHUB_ACTIONS_EPIDATA_API_KEY }} | |
steps: | |
- name: Checkout repo | |
uses: actions/checkout@v3 | |
with: | |
fetch-depth: 0 | |
- name: Setup R | |
uses: r-lib/actions/setup-r@v2 | |
with: | |
use-public-rspm: true | |
- name: Install dependencies | |
uses: r-lib/actions/setup-r-dependencies@v2 | |
with: | |
extra-packages: | | |
any::devtools | |
any::roxygen2 | |
needs: | | |
devtools | |
roxygen2 | |
- name: Document | |
run: roxygen2::roxygenise() | |
shell: Rscript {0} | |
- name: Build README.md from README.Rmd | |
run: Rscript -e 'if (file.exists("README.Rmd")) devtools::build_readme()' | |
- name: Commit and push changes | |
run: | | |
git config --local user.name "$GITHUB_ACTOR" | |
git config --local user.email "[email protected]" | |
git add README.md | |
git add man/\* NAMESPACE DESCRIPTION | |
git commit -m "docs: document (GHA)" || echo "No changes to commit" | |
git pull --rebase | |
git push origin |