shadi/.github/workflows/docs-pages.yml at main · agntcy/shadi · 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
96
97
98
99
100
name: Build and Publish Documentation

on:
  push:
    branches:
      - main
    tags:
      - "v*.*.*"
    paths:
      - "docs/**"
      - "mkdocs.yml"
      - "overrides/**"
      - "assets/**"
  pull_request:
    paths:
      - "docs/**"
      - "mkdocs.yml"
      - "overrides/**"
      - "assets/**"
  workflow_dispatch:

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

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  prepare:
    name: Prepare
    runs-on: ubuntu-latest
    outputs:
      release_tag: ${{ steps.vars.outputs.release_tag }}
    steps:
      - name: Resolve required vars
        id: vars
        run: |
          echo "release_tag=${GITHUB_REF#refs/tags/}" >> "$GITHUB_OUTPUT"

  docs:
    name: Docs
    needs:
      - prepare
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pages: write
      id-token: write
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"
      - name: Install docs dependencies
        run: |
          curl -LsSf https://astral.sh/uv/install.sh | sh
          echo "$HOME/.cargo/bin" >> "$GITHUB_PATH"
          uv pip install --system mkdocs mkdocs-material pymdown-extensions
      - name: Install just
        uses: taiki-e/install-action@v2
        with:
          tool: just
      - name: Build docs
        run: just docs-build
      - name: Configure Pages
        if: ${{ github.event_name != 'pull_request' }}
        uses: actions/configure-pages@v5
      - name: Upload Pages artifact
        if: ${{ github.event_name != 'pull_request' }}
        uses: actions/upload-pages-artifact@v3
        with:
          path: site

  deploy:
    needs: docs
    if: ${{ github.event_name != 'pull_request' }}
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4

  success:
    name: Success
    if: ${{ !cancelled() && !contains(needs.*.result, 'cancelled') && !contains(needs.*.result, 'failure') }}
    needs:
      - prepare
      - docs
    runs-on: ubuntu-latest
    steps:
      - name: Echo Success
        run: echo "::notice Success!"