Document-PSModule/.github/workflows/Action-Test.yml at main · PSModule/Document-PSModule · 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
name: Action-Test

run-name: "Action-Test - [${{ github.event.pull_request.title }} #${{ github.event.pull_request.number }}] by @${{ github.actor }}"

on:
  push:
    branches:
      - main
  workflow_dispatch:
  pull_request:
  schedule:
    - cron: '0 0 * * *'

env:
  GH_TOKEN: ${{ github.token }}

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

permissions:
  contents: read # to checkout the repo

jobs:
  UploadArtifact:
    name: Upload Artifact
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repo
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
        with:
          persist-credentials: false
          fetch-depth: 0

      - name: Upload module artifact
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: module
          path: tests/srcTestRepo/outputs/module
          if-no-files-found: error
          retention-days: 1

  ActionTestDefault:
    name: Action-Test - [Default]
    runs-on: ubuntu-latest
    needs: UploadArtifact
    permissions:
      contents: read
      statuses: write # to create commit status from linter
    steps:
      - name: Checkout repo
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
        with:
          persist-credentials: false
          fetch-depth: 0

      - name: Action-Test
        uses: ./
        with:
          Name: PSModuleTest
          WorkingDirectory: tests/srcTestRepo

      - name: Verify group overview pages publish as section index
        shell: pwsh
        run: |
          $docs = 'tests/srcTestRepo/outputs/docs'
          # PSModule: <Group>/<Group>.md mapped to index.md. SomethingElse: explicit index.md
          # passthrough. Widgets: Index.md normalized to index.md (case-insensitive).
          $expected = @('PSModule/index.md', 'SomethingElse/index.md', 'Widgets/index.md')
          $unexpected = @('PSModule/PSModule.md', 'SomethingElse/SomethingElse.md', 'Widgets/Index.md')
          $failed = $false
          foreach ($rel in $expected) {
              if (Test-Path (Join-Path $docs $rel)) { Write-Host "OK  present: $rel" }
              else { Write-Host "ERR missing: $rel"; $failed = $true }
          }
          foreach ($rel in $unexpected) {
              if (Test-Path (Join-Path $docs $rel)) { Write-Host "ERR should not exist: $rel"; $failed = $true }
              else { Write-Host "OK  absent:  $rel" }
          }
          if ($failed) { throw 'Group overview pages were not published as section index (index.md).' }

      - name: Lint documentation
        uses: super-linter/super-linter/slim@4ce20838b8ab83717e78138c5b3a1407148e0918 # v8.7.0
        env:
          GITHUB_TOKEN: ${{ github.token }}
          VALIDATE_MARKDOWN: true
          VALIDATE_NATURAL_LANGUAGE: true
          VALIDATE_ALL_CODEBASE: true
          USE_FIND_ALGORITHM: true

  ActionTestWithSummary:
    name: Action-Test - [With Summary]
    runs-on: ubuntu-latest
    needs: UploadArtifact
    steps:
      - name: Checkout repo
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
        with:
          persist-credentials: false
          fetch-depth: 0

      - name: Action-Test
        uses: ./
        with:
          Name: PSModuleTest
          WorkingDirectory: tests/srcTestRepo
          ShowSummaryOnSuccess: true