Action-Test - [Publish group overview pages as the section index (index.md) #53] by @MariusStorhaug #731
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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' | |
| $expected = @('PSModule/index.md', 'SomethingElse/index.md') | |
| $unexpected = @('PSModule/PSModule.md', 'SomethingElse/SomethingElse.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 |