statista/.github/workflows/github-pages-mkdocs.yml at main · serapeum-org/statista · 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
name: Deploy MkDocs

permissions:
  contents: write
  pages: write

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - '**'
  release:
      types:
        - published
  workflow_run:
    workflows: ['github-release']
    types: [completed]


jobs:
  deploy-pr:
    if: github.event_name == 'pull_request'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
        with:
          fetch-depth: 0

      - uses: serapeum-org/github-actions/actions/mkdocs-deploy@mkdocs/v1
        with:
          trigger: 'pull_request'
          package-manager: 'uv'
          python-version: '3.12'
          install-groups: 'groups: docs'
          deploy-token: ${{ secrets.ACTIONS_DEPLOY_TOKEN }}
          notebooks-path: 'docs/notebook'

  deploy-main:
    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
        with:
          fetch-depth: 0

      - uses: serapeum-org/github-actions/actions/mkdocs-deploy@mkdocs/v1
        with:
          trigger: 'main'
          package-manager: 'uv'
          python-version: '3.12'
          install-groups: 'groups: docs'
          deploy-token: ${{ secrets.ACTIONS_DEPLOY_TOKEN }}
          notebooks-path: 'docs/notebook'

  deploy-release:
    if: github.event_name == 'release' || (github.event_name == 'workflow_run' && github.event.workflow_run.conclusion == 'success')
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
        with:
          fetch-depth: 0
          ref: ${{ github.event_name == 'workflow_run' && github.event.workflow_run.head_branch || '' }}

      - uses: serapeum-org/github-actions/actions/mkdocs-deploy@mkdocs/v1
        with:
          trigger: 'release'
          package-manager: 'uv'
          python-version: '3.12'
          install-groups: 'groups: docs'
          deploy-token: ${{ secrets.ACTIONS_DEPLOY_TOKEN }}
          notebooks-path: 'docs/notebook'
          mike-alias: 'latest'