Skip to content

render readme

render readme #1

# force render readme
name: render-readme
on:
push:
branches: [main, master]
pull_request:
branches: [main, master]
permissions: read-all
jobs:
render-rmarkdown:
runs-on: ubuntu-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- uses: r-lib/actions/setup-r@v2
- uses: r-lib/actions/setup-pandoc@v2
# install packages needed
- name: install required packages
run: Rscript -e 'install.packages(c("rmarkdown"))'
# Render README.md using rmarkdown
- name: render README
run: Rscript -e 'rmarkdown::render("README.Rmd", output_format = "md_document")'
- name: commit rendered README
run: |
git add README.md man/figures/README-*
git commit -m "Re-build README.md" || echo "No changes to commit"
git push origin master || echo "No changes to commit"