TNFR-Python-Engine/.github/workflows/docs.yml at main · fermga/TNFR-Python-Engine · 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
name: Documentation

on:
  push:
    branches: [main]
    paths:
      - '**.md'
      - 'TNFR_lineas_de_investigacion.txt'
      - 'docs/assets/**'
      - 'applications/factorization-lab/notebooks/**'
      - 'src/tnfr/operators/operator_contracts.py'
      - 'tests/scripts/test_documentation.py'
      - 'tests/scripts/test_glossary.py'
      - 'mkdocs.yml'
      - 'pyproject.toml'
      - '.zenodo.json'
      - 'CITATION.cff'
      - 'src/tnfr/_version.py'
      - 'scripts/check_documentation.py'
      - 'scripts/check_glossary.py'
      - 'scripts/prepare_docs.py'
      - 'scripts/clean_repository.py'
      - 'scripts/verify_internal_references.py'
      - '.github/workflows/docs.yml'
  pull_request:
    branches: [main]
    paths:
      - '**.md'
      - 'TNFR_lineas_de_investigacion.txt'
      - 'docs/assets/**'
      - 'applications/factorization-lab/notebooks/**'
      - 'src/tnfr/operators/operator_contracts.py'
      - 'tests/scripts/test_documentation.py'
      - 'tests/scripts/test_glossary.py'
      - 'mkdocs.yml'
      - 'pyproject.toml'
      - '.zenodo.json'
      - 'CITATION.cff'
      - 'src/tnfr/_version.py'
      - 'scripts/check_documentation.py'
      - 'scripts/check_glossary.py'
      - 'scripts/prepare_docs.py'
      - 'scripts/clean_repository.py'
      - 'scripts/verify_internal_references.py'
      - '.github/workflows/docs.yml'
  workflow_dispatch: {}

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

permissions:
  contents: write

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: actions/setup-python@v6
        with:
          python-version: '3.11'
          cache: pip
      - name: Install project and documentation dependencies
        run: python -m pip install --upgrade pip && python -m pip install '.[docs]'
      - name: Verify documentation sources
        run: |
          python scripts/verify_internal_references.py --ci
          python scripts/check_documentation.py
      - name: Build canonical site
        run: |
          python scripts/prepare_docs.py
          python -m mkdocs build --strict
      - name: Deploy main documentation
        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./site
          publish_branch: gh-pages
          force_orphan: true
          user_name: github-actions[bot]
          user_email: github-actions[bot]@users.noreply.github.com
          commit_message: docs publish ${{ github.sha }}