examples/.github/workflows/docs.yaml at 086d73269499104f08df5b7f72be15b7d59cc871 · pharmaverse/examples · 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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
---
name: Build & Deploy Website

on:
  workflow_call:
    secrets:
      REPO_GITHUB_TOKEN:
        description: |
          Github token with write access to the repository
        required: false
  pull_request:
    types:
      - opened
      - synchronize
      - reopened
      - ready_for_review
    branches:
      - main
  push:
    branches:
      - main
  schedule:
    - cron: "10 10 * * *"
  workflow_dispatch:

jobs:
  build-deploy:
    name: Build & Deploy Website
    if: "github.event_name != 'pull_request' || !contains(github.event.pull_request.title, '[skip website]')"
    runs-on: ubuntu-latest
    steps:
      - name: Check out repository
        uses: actions/checkout@v4

      - name: Cache artifacts
        uses: actions/cache@v4
        with:
          path: _freeze
          key: ${{ runner.os }}-examples

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

      - name: Install Jupyter
        run: python3 -m pip install jupyter

      - name: Setup R
        uses: r-lib/actions/setup-r@v2

      - name: Setup R Dependencies
        uses: r-lib/actions/setup-r-dependencies@v2

      - name: Render Quarto Project
        uses: quarto-dev/quarto-actions/render@v2
        with:
          to: html

      - name: Publish docs
        # runs when main branch is updated, or when a PR is merged into main
        if: github.ref == 'refs/heads/main'
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./_site

      - name: Publish PR docs in a subdirectory
        # runs when a PR is opened or updated, but not when merged into main
        if: github.event_name == 'pull_request' && github.base_ref == 'main'
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./_site
          destination_dir: ${{ github.head_ref }}

      - name: Create comment
        # runs when a PR is opened or updated, but not when merged into main
        if: github.event_name == 'pull_request' && github.base_ref == 'main'
        uses: marocchino/sticky-pull-request-comment@v2
        with:
          header: "Documentation Website"
          message: |
            The website is available at https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/${{ github.head_ref }}.
        env:
          GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}