r-project-template/.github/workflows/generate-docs.yml at main · novica/r-project-template · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
name: Generate Documentation

on:
  push:
    branches: [main]
    paths:
      - "docs/**"
      - ".github/workflows/generate-docs.yml"
      - "src/package_name/**" # rebuild if API docs change

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: docs-pages
  cancel-in-progress: true

jobs:
  docs:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v6

      - name: Set up R
        uses: r-lib/actions/setup-r@v2
        with:
          r-version: "4.5"

      - name: Set up quarto
        uses: quarto-dev/quarto-actions/setup@v2

      - name: Install rv
        run: curl -sSL https://raw.githubusercontent.com/A2-ai/rv/refs/heads/main/scripts/install.sh | bash

      - name: Sync project
        run: rv sync

      - name: Run Quartrify
        run: Rscript -e "quartify::rtoqmd_dir('src/package_name/', render = TRUE,  output_html_dir = '../../docs/html', exclude_pattern='__tests__')"
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v4
        with:
          path: "./docs/html/"

  deploy:
    runs-on: ubuntu-latest
    needs: docs
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Setup Pages
        uses: actions/configure-pages@v6

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5