Docs: R Markdown

.github/workflows/docs.yaml

@@ -0,0 +1,101 @@
+name: "docs"
+
+on:
+  pull_request:
+    types: [ "opened", "synchronize", "edited", "reopened" ]
+  push:
+    branches:
+      - "**"
+
+concurrency:
+  group: "${{ github.workflow }}-${{ github.head_ref || github.ref_name }}"
+  cancel-in-progress: true
+
+jobs:
+  convert:
+    name: "Convert R Markdown files to regular Markdown"
+    runs-on: "ubuntu-latest"
+    env:
+      R_COMPILE_AND_INSTALL_PACKAGES: "never"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v2"
+
+      - name: "Rrrr DESCRIPTION file"
+        run: |
+          cat <<EOF >DESCRIPTION
+          Package: Rrrrrrrrr Markdown generator
+          Version: 0.1
+          EOF
+
+      - name: "Rrrr"
+        uses: "r-lib/actions/setup-r@v1"
+
+      - name: "Rrrr dependencies"
+        uses: "r-lib/actions/setup-r-dependencies@v2"
+        with:
+          cache-version: 1
+          extra-packages: |
+            any::rmarkdown
+
+      - name: "Pandoc"
+        uses: "r-lib/actions/setup-pandoc@v1"
+
+      - name: "Find removed files"
+        uses: "dorny/paths-filter@v2"
+        id: "removed"
+        with:
+          list-files: "shell"
+          filters: |
+            Rmd:
+              - removed: '*.Rmd'
+
+      - name: "Cleanup"
+        run: |
+          for Rmd in ${{ steps.removed.outputs.Rmd }}
+          do
+            md="${Rmd%.*}.md"
+            rm $md
+          done
+
+      - name: "Find changed files"
+        uses: "dorny/paths-filter@v2"
+        id: "changed"
+        with:
+          list-files: "shell"
+          filters: |
+            Rmd:
+              - '*.Rmd'
+
+      - name: "Convert"
+        run: |
+          for Rmd in ${{ steps.changed.outputs.Rmd }}
+          do
+            Rscript -e 'rmarkdown::render("$Rmd", output_format = "md_document")'
+          done
+
+      - name: "Commit"
+        run: |
+          git add *.md
+          git -vm "Build .md files from .Rmd" || echo "No changes to commit"
+          git push origin || true
+
+  status-check:
+    name: "Status check - docs"
+    runs-on: "ubuntu-latest"
+    needs: [ "convert" ]
+
+    if: "${{ always() }}"
+
+    steps:
+      - name: "Check required jobs are successful"
+        env:
+          RESULTS: "${{ join(needs.*.result, ' ') }}"
+        run: |
+          for res in $RESULTS
+          do
+            if [ $res != 'success' ]; then
+              exit 1
+            fi
+          done