Workflow-Test [WithManifest] - [⚙️ [Maintenance]: Root Functions landing pages are now covered #409] by @MariusStorhaug #1730
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: Workflow-Test [WithManifest] | |
| run-name: 'Workflow-Test [WithManifest] - [${{ github.event.pull_request.title }} #${{ github.event.pull_request.number }}] by @${{ github.actor }}' | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| paths: | |
| - '.github/actions/**' | |
| - '.github/workflows/**' | |
| - 'tests/srcWithManifestTestRepo/**' | |
| - '!.github/workflows/Release.yml' | |
| - '!.github/workflows/Linter.yml' | |
| schedule: | |
| - cron: '0 0 * * *' | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| statuses: write | |
| pages: write | |
| id-token: write | |
| jobs: | |
| WorkflowTestWithManifest: | |
| if: ${{ github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository }} | |
| uses: ./.github/workflows/workflow.yml | |
| secrets: | |
| APIKey: ${{ secrets.APIKey }} | |
| TestData: >- | |
| { | |
| "secrets": { | |
| "PSMODULE_TEST_SINGLELINE_SECRET": "${{ secrets.PSMODULE_TEST_SINGLELINE_SECRET }}" | |
| }, | |
| "variables": { | |
| "PSMODULE_TEST_VARIABLE": ${{ toJSON(vars.PSMODULE_TEST_VARIABLE) }} | |
| } | |
| } | |
| with: | |
| WorkingDirectory: tests/srcWithManifestTestRepo | |
| ImportantFilePatterns: | | |
| ^src/ | |
| ^README\.md$ | |
| ^\.github/actions/ | |
| ^\.github/workflows/(?!Release\.yml$|Linter\.yml$) | |
| VerifyRootFunctionsIndexWithManifest: | |
| name: Verify root Functions index [WithManifest] | |
| runs-on: ubuntu-latest | |
| needs: | |
| - WorkflowTestWithManifest | |
| steps: | |
| - name: Checkout repo | |
| uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | |
| with: | |
| persist-credentials: false | |
| fetch-depth: 0 | |
| - name: Download docs artifact | |
| uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 | |
| with: | |
| name: docs | |
| path: tests/srcWithManifestTestRepo/outputs/docs | |
| - name: Verify root Functions index is published | |
| shell: pwsh | |
| run: | | |
| $path = 'tests/srcWithManifestTestRepo/outputs/docs/index.md' | |
| if (-not (Test-Path -Path $path)) { | |
| throw 'Expected root Functions index at tests/srcWithManifestTestRepo/outputs/docs/index.md.' | |
| } | |
| $content = Get-Content -Path $path -Raw | |
| $expectedSnippets = @( | |
| 'ms.title: Functions' | |
| '# Functions' | |
| 'This landing page is authored from the root of `src/functions/public`.' | |
| 'Use it to introduce the module''s function surface before readers drill into each group.' | |
| ) | |
| foreach ($snippet in $expectedSnippets) { | |
| if ($content -notlike "*$snippet*") { | |
| throw "Expected snippet not found in generated root Functions index: $snippet" | |
| } | |
| } |