dm/.github/workflows/pkgdown.yaml at main · cynkra/dm · 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
61
62
63
64
65
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
# Also included in R-CMD-check.yaml, this workflow only listens to pushes to branches
# that start with "docs*" or "cran-*" and does not need to act on pushes to the main branch.
on:
  push:
    branches:
      - "docs*"
      - "cran-*"
      # The main branch is excluded here, it is handled by the R-CMD-check workflow.
      # This workflow is only for handling pushes to designated branches.
  workflow_dispatch:

name: pkgdown

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}-${{ github.head_ref || github.sha }}-${{ github.base_ref || '' }}
  cancel-in-progress: true

permissions: {}

jobs:
  pkgdown:
    runs-on: ubuntu-26.04

    name: "pkgdown"

    permissions:
      # Required by pkgdown::deploy_to_branch(), which pushes to gh-pages
      contents: write

    steps:
      - uses: actions/checkout@v6

      - name: Report the GitHub API rate limit
        uses: ./.github/workflows/rate-limit
        with:
          token: ${{ secrets.GITHUB_TOKEN }}

      - name: Configure the Git identity
        uses: ./.github/workflows/git-identity
        if: github.event_name == 'push'

      - name: Run the repository-specific before-install steps
        uses: ./.github/workflows/custom/before-install
        if: hashFiles('.github/workflows/custom/before-install/action.yml') != ''

      - name: Install R and the package dependencies
        uses: ./.github/workflows/install
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          cache-version: pkgdown-2
          needs: website
          extra-packages: r-lib/pkgdown local::.

      - name: Run the repository-specific after-install steps
        uses: ./.github/workflows/custom/after-install
        if: hashFiles('.github/workflows/custom/after-install/action.yml') != ''

      - name: Build the pkgdown website
        uses: ./.github/workflows/pkgdown-build
        if: github.event_name != 'push'

      - name: Build and deploy the pkgdown website
        uses: ./.github/workflows/pkgdown-deploy
        if: github.event_name == 'push'