docs/.github/workflows/Docs.yml at main · MSXOrg/docs · 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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
name: Docs

on:
  workflow_dispatch:
  # No paths filter on purpose: this is the only workflow, so every push and pull
  # request must run it to lint and build the full documented surface — including
  # root files such as README.md, .github/dependabot.yml, and .prettierrc.json. A
  # paths allow-list would silently skip CI for changes outside it.
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  # Cancel superseded PR runs for fast iteration, but let main-branch runs finish
  # so a Pages deploy is never cancelled mid-publish.
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

# Default-deny floor for this multi-job workflow: each job below grants only the
# scopes its steps need, so a job that omits its own permissions block (including
# one added later) inherits nothing and fails closed. See the GitHub Actions
# coding standard, "Grant least-privilege permissions".
permissions: {}

jobs:
  lint:
    name: Lint
    runs-on: ubuntu-24.04
    permissions:
      contents: read
      packages: read # super-linter: read packages
      statuses: write # super-linter: report status checks
    steps:
      - name: Checkout repository
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
        with:
          fetch-depth: 0
          persist-credentials: false

      - name: Lint code base
        uses: super-linter/super-linter@4ce20838b8ab83717e78138c5b3a1407148e0918 # v8.7.0
        env:
          GITHUB_TOKEN: ${{ github.token }}
          # Vendored/minified third-party assets are not our code — don't lint them.
          FILTER_REGEX_EXCLUDE: '.*\.min\.(js|css)$'
          VALIDATE_BIOME_LINT: false
          VALIDATE_BIOME_FORMAT: false
          VALIDATE_JSCPD: false
          VALIDATE_JSON_PRETTIER: false
          VALIDATE_MARKDOWN_PRETTIER: false
          VALIDATE_YAML_PRETTIER: false
          VALIDATE_HTML_PRETTIER: false
          # Python: lint with ruff, mypy, and isort; disable the formatters (version-coupled and mutually conflicting)
          VALIDATE_PYTHON_BLACK: false
          VALIDATE_PYTHON_FLAKE8: false
          VALIDATE_PYTHON_PYLINT: false
          VALIDATE_PYTHON_PYINK: false
          VALIDATE_PYTHON_RUFF_FORMAT: false

  build:
    name: Build
    runs-on: ubuntu-24.04
    permissions:
      contents: read
    steps:
      - name: Checkout repository
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
        with:
          persist-credentials: false

      - name: Set up Python
        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
        with:
          python-version: 3.x

      - name: Verify documentation indexes
        shell: pwsh
        run: ./.github/scripts/Update-DocumentationIndex.ps1 -Check

      - name: Install Zensical
        run: pip install -r requirements.txt

      - name: Build Zensical project
        run: zensical build --clean
        working-directory: src

      - name: Upload pages artifact
        uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
        with:
          path: src/site

  links:
    name: Links
    runs-on: ubuntu-24.04
    permissions:
      contents: read
    steps:
      - name: Checkout repository
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
        with:
          persist-credentials: false

      - name: Validate documentation links
        shell: pwsh
        run: ./.github/scripts/Test-DocumentationLink.ps1

  publish:
    name: Publish
    needs: [build, lint, links]
    if: github.event_name != 'pull_request'
    runs-on: ubuntu-24.04
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    permissions:
      contents: read
      pages: write # deploy to GitHub Pages
      id-token: write # OIDC token for actions/deploy-pages
    steps:
      - name: Configure pages
        uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0

      - name: Deploy to GitHub Pages
        uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0
        id: deployment