render-README.yaml

on:
  push:
    paths:
      - 'README.Rmd'
  workflow_dispatch:

name: Render README

jobs:
  build:
    runs-on: ubuntu-latest
    env:
      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
    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 pandoc
        uses: r-lib/actions/setup-pandoc@v2

      - name: Install package dependencies
        uses: r-lib/actions/setup-r-dependencies@v2
        with:
          extra-packages: rmarkdown, local::.

      - name: Render README.Rmd
        run:  Rscript -e 'rmarkdown::render("README.Rmd")'

      - name: Commit and create a Pull Request on master
        if: ${{ github.ref == 'refs/heads/master' }}
        uses: peter-evans/create-pull-request@v4
        with:
          commit-message: "Automated re-knit of the README"
          branch: document_master
          delete-branch: true
          title: Re-knit README.md due to changes made to README.Rmd
          labels: documentation,Maintainance
          assignees: ${{ github.actor }}
          reviewers: ${{ github.actor }}

      - name: Commit and push changes on all other branches
        if: ${{ github.ref != 'refs/heads/master' }}
        uses: stefanzweifel/git-auto-commit-action@v4
        with:
          commit_message: "Automated re-knit of the README"