bpp/.github/workflows/docs.yml at dev · iplweb/bpp · 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
name: Docs

# Buduje dokumentacje MkDocs Material w trybie --strict jako PR check.
# Workflow nie konsumuje zadnych nieZaufanych inputow (issue/PR titles,
# commit messages), wiec wzorce z https://github.blog/security/...
# nie maja tu zastosowania.

on:
  push:
    branches:
      - dev
      - master
    paths:
      - docs/**
      - mkdocs.yml
      - .readthedocs.yaml
      - .github/workflows/docs.yml
  pull_request:
    branches:
      - dev
    paths:
      - docs/**
      - mkdocs.yml
      - .readthedocs.yaml
      - .github/workflows/docs.yml

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

permissions:
  contents: read

jobs:
  build:
    name: mkdocs build --strict
    runs-on: ubuntu-latest
    timeout-minutes: 5

    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
        with:
          python-version: "3.11"
          cache: pip
          cache-dependency-path: docs/requirements.txt

      - name: Install MkDocs + plugins
        run: pip install -r docs/requirements.txt

      - name: Build docs (strict mode)
        run: mkdocs build --strict --verbose

      - name: Upload built site as artifact
        uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
        with:
          name: docs-site
          path: site/
          retention-days: 7