docket/.github/workflows/docs.yml at 1538e9f043bb71c3f6d4971fcc16ea8d5a704310 · chrisguidry/docket · 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
85
86
87
88
89
90
91
92
93
94
95
name: Documentation

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

permissions:
  actions: write
  contents: read
  pages: write
  id-token: write
  pull-requests: write

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0

      - name: Install uv and set Python version
        uses: astral-sh/setup-uv@v7
        with:
          python-version: "3.12"
          enable-cache: true
          cache-dependency-glob: "pyproject.toml"

      - name: Install dependencies
        run: uv sync --group docs

      - name: Build documentation
        run: uv run mkdocs build

      - name: Upload artifact
        uses: actions/upload-artifact@v6
        id: docs-artifact
        with:
          name: documentation
          path: site/

      - name: Add or Update Comment
        if: github.event_name == 'pull_request'
        uses: marocchino/sticky-pull-request-comment@v2
        with:
          header: preview
          message: |
            📚 Documentation has been built for this PR!

            You can download the documentation directly here:
            ${{ steps.docs-artifact.outputs.artifact-url }}

  publish:
    needs: build
    if: github.ref == 'refs/heads/main'
    runs-on: ubuntu-latest
    timeout-minutes: 10
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Download artifact
        uses: actions/download-artifact@v7
        with:
          name: documentation
          path: site

      - name: Setup Pages
        uses: actions/configure-pages@v5

      # Clean up any stale github-pages artifacts from previous attempts
      # See: https://github.com/actions/upload-pages-artifact/issues/97
      - name: Delete stale Pages artifacts
        uses: geekyeggo/delete-artifact@v5
        with:
          name: github-pages
          failOnError: false

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v4
        with:
          path: site

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