docs/.github/workflows/Docs.yml at e74623231aaecb5d456e9ca32d15e2d4ac329c3e · PSModule/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
129
130
131
132
133
name: Docs

on:
  workflow_dispatch:
  push:
    branches:
      - main
    paths:
      - src/**
      - .github/scripts/**
      - .github/workflows/Docs.yml
      - .github/workflows/Update-Index.yml
  pull_request:
    branches:
      - main
    paths:
      - src/**
      - .github/workflows/Docs.yml
      - .github/workflows/Update-Index.yml

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

permissions:
  contents: read

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@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          fetch-depth: 0
          persist-credentials: false

      - name: Lint code base
        uses: super-linter/super-linter@9e863354e3ff62e0727d37183162c4a88873df41 # v8.6.0
        env:
          GITHUB_TOKEN: ${{ github.token }}
          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

  update-index:
    name: Update index
    needs: lint
    if: github.event_name != 'pull_request'
    runs-on: ubuntu-24.04
    steps:
      - name: Connect and show repos
        uses: PSModule/GitHub-Script@1ee97bbc652d19c38ae12f6e1e47e9d9fbd12d0a # v1.8.0
        with:
          # Org-level shared secrets used across multiple repositories — no dedicated GitHub Environment needed.
          ClientID: ${{ secrets.SCRIBBLER_BOT_CLIENT_ID }} # zizmor: ignore[secrets-outside-env]
          PrivateKey: ${{ secrets.SCRIBBLER_BOT_PRIVATE_KEY }} # zizmor: ignore[secrets-outside-env]
          Script: .github/scripts/Connect-And-Show-Repos.ps1

      - name: Update module index
        uses: PSModule/GitHub-Script@1ee97bbc652d19c38ae12f6e1e47e9d9fbd12d0a # v1.8.0
        with:
          Script: .github/scripts/Update-ModuleIndex.ps1

      - name: Update action index
        uses: PSModule/GitHub-Script@1ee97bbc652d19c38ae12f6e1e47e9d9fbd12d0a # v1.8.0
        with:
          Script: .github/scripts/Update-ActionIndex.ps1

      - name: Update function app index
        uses: PSModule/GitHub-Script@1ee97bbc652d19c38ae12f6e1e47e9d9fbd12d0a # v1.8.0
        with:
          Script: .github/scripts/Update-FunctionAppIndex.ps1


  build:
    name: Build
    needs: [lint, update-index]
    if: always() && needs.lint.result == 'success' && (needs.update-index.result == 'success' || needs.update-index.result == 'skipped')
    runs-on: ubuntu-24.04
    permissions:
      contents: read
    steps:
      - name: Checkout repository
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          persist-credentials: false

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

      - name: Install Zensical
        run: pip install zensical

      - 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

  publish:
    name: Publish
    needs: build
    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@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0

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