tracker-tracker/.github/workflows/docs.yml at main · bitglows/tracker-tracker · 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
# .github/workflows/docs.yml
name: Docs

on:
  push:
    branches: [main]
    paths:
      - "docs/kb/**"
      - ".github/workflows/docs.yml"
  pull_request:
    branches: [main]
    paths:
      - "docs/kb/**"
      - ".github/workflows/docs.yml"
  workflow_dispatch:

permissions:
  contents: write

jobs:
  build:
    name: Docs Build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - uses: actions/setup-python@v6
        with:
          python-version: "3.x"

      - name: Install MkDocs Material
        run: pip install -r docs/kb/requirements.txt

      - name: Build docs
        run: mkdocs build --strict --config-file docs/kb/mkdocs.yml

  deploy:
    name: Docs Deploy
    needs: build
    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - uses: actions/setup-python@v6
        with:
          python-version: "3.x"

      - name: Install MkDocs Material
        run: pip install -r docs/kb/requirements.txt

      - name: Deploy to GitHub Pages
        run: mkdocs gh-deploy --force --config-file docs/kb/mkdocs.yml