Rule doc improvements (#3140) #1386
This file contains 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
| # | |
| # Build documentation site | |
| # | |
| # NOTES: | |
| # This workflow generates and published the documentation site https://azure.github.io/PSRule.Rules.Azure/. | |
| name: Docs | |
| on: | |
| push: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| permissions: {} | |
| env: | |
| DOTNET_NOLOGO: true | |
| DOTNET_CLI_TELEMETRY_OPTOUT: true | |
| jobs: | |
| publish: | |
| name: Publish docs | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Configure | |
| run: | | |
| git config user.name github-actions | |
| git config user.email '41898282+github-actions[bot]@users.noreply.github.com' | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11' | |
| architecture: x64 | |
| - name: Setup .NET | |
| uses: actions/setup-dotnet@v4 | |
| - name: Install dependencies | |
| run: | | |
| python3 -m pip install --upgrade pip | |
| python3 -m pip install wheel | |
| python3 -m pip install -r requirements-docs.txt | |
| - name: Build docs | |
| run: | | |
| Install-Module InvokeBuild -MinimumVersion 5.4.0 -Scope CurrentUser -Force | |
| Invoke-Build BuildDocs | |
| shell: pwsh | |
| - name: Checkout gh-pages | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: refs/heads/gh-pages | |
| path: site/ | |
| - name: Build site | |
| run: mkdocs build | |
| env: | |
| MKDOCS_GIT_COMMITTERS_APIKEY: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Push content | |
| run: | | |
| cd site/ | |
| git config user.name github-actions | |
| git config user.email '41898282+github-actions[bot]@users.noreply.github.com' | |
| git add . | |
| git commit -m "deploy ${{ github.sha }}" | |
| git push --force | |
| deploy: | |
| name: Deploy pages | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: [publish] | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: false | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: refs/heads/gh-pages | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: '.' | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |