build(deps-dev): Bump the docs-dependencies group across 1 directory with 3 updates #125
Workflow file for this run
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: Docs | |
| on: | |
| push: | |
| branches: ["main"] | |
| paths: | |
| - "docs/**" | |
| - "examples/**" | |
| - "internal/plan/**" | |
| - "internal/resources/**" | |
| - "internal/temporal/**" | |
| - "internal/webhook/**" | |
| - "cmd/preview-wasm/**" | |
| - "api/**" | |
| pull_request: | |
| branches: ["main"] | |
| paths: | |
| - "docs/**" | |
| - "examples/**" | |
| - "internal/plan/**" | |
| - "internal/resources/**" | |
| - "internal/temporal/**" | |
| - "internal/webhook/**" | |
| - "cmd/preview-wasm/**" | |
| - "api/**" | |
| permissions: | |
| contents: read | |
| jobs: | |
| lint: | |
| name: Lint docs | |
| runs-on: namespace-profile-temporal-operator | |
| steps: | |
| - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | |
| with: | |
| persist-credentials: false | |
| - name: Lint Markdown | |
| uses: DavidAnson/markdownlint-cli2-action@ded1f9488f68a970bc66ea5619e13e9b52e601cd # v23.2.0 | |
| with: | |
| globs: | | |
| docs/**/*.md | |
| examples/**/*.md | |
| !docs/content/reference/** | |
| !docs/content/examples/** | |
| !docs/api/** | |
| !docs/themes/** | |
| !docs/superpowers/** | |
| config: ".markdownlint.yaml" | |
| - name: Check links | |
| uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2.8.0 | |
| with: | |
| args: --no-progress --accept 200,206,429 docs/**/*.md examples/**/*.md --exclude-path docs/content/reference --exclude-path docs/content/examples --exclude-path docs/api --exclude-path docs/themes --exclude-path docs/superpowers | |
| fail: false | |
| verify-generated: | |
| name: Verify generated docs | |
| runs-on: namespace-profile-temporal-operator | |
| steps: | |
| - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | |
| with: | |
| persist-credentials: false | |
| - name: Setup Go | |
| uses: actions/setup-go@924ae3a1cded613372ab5595356fb5720e22ba16 # v6.5.0 | |
| with: | |
| go-version: "1.26.x" | |
| - name: Regenerate CRD reference docs | |
| run: make api-docs docs-crd-reference | |
| - name: Fail if generated docs are stale | |
| run: | | |
| if ! git diff --quiet -- docs/api/v1alpha1.md docs/content/reference/_index.md; then | |
| echo "::error::Generated CRD docs are out of date. Run 'make api-docs docs-crd-reference' and commit the result." | |
| git --no-pager diff -- docs/api/v1alpha1.md docs/content/reference/_index.md | |
| exit 1 | |
| fi | |
| preview-wasm: | |
| name: Preview wasm + docs build | |
| runs-on: namespace-profile-temporal-operator | |
| steps: | |
| - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | |
| with: | |
| submodules: recursive | |
| persist-credentials: false | |
| - name: Setup Go | |
| uses: actions/setup-go@924ae3a1cded613372ab5595356fb5720e22ba16 # v6.5.0 | |
| with: | |
| go-version: "1.26.x" | |
| - name: Build preview WebAssembly | |
| run: make preview-wasm | |
| - name: Setup Node | |
| uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 | |
| with: | |
| node-version: "22" | |
| - name: Install docs CSS tooling | |
| run: npm ci | |
| working-directory: docs | |
| - name: Setup Hugo | |
| uses: peaceiris/actions-hugo@2752ce1d29631191ea3f27c23495fa06139a5b78 # v3.2.1 | |
| with: | |
| hugo-version: "0.140.2" | |
| extended: true | |
| - name: Generate examples docs | |
| run: make docs-examples | |
| - name: Build site (no deploy) | |
| run: PATH="$PWD/docs/node_modules/.bin:$PATH" hugo --source docs --minify | |
| build-deploy: | |
| name: Build and deploy site | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | |
| runs-on: namespace-profile-temporal-operator | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: false | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | |
| with: | |
| submodules: recursive | |
| fetch-depth: 0 | |
| persist-credentials: false | |
| - name: Setup Go | |
| uses: actions/setup-go@924ae3a1cded613372ab5595356fb5720e22ba16 # v6.5.0 | |
| with: | |
| go-version: "1.26.x" | |
| - name: Setup Node | |
| uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 | |
| with: | |
| node-version: "22" | |
| - name: Install docs CSS tooling | |
| run: npm ci | |
| working-directory: docs | |
| - name: Build preview WebAssembly | |
| run: make preview-wasm | |
| - name: Setup Pages | |
| id: pages | |
| uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0 | |
| - name: Setup Hugo | |
| uses: peaceiris/actions-hugo@2752ce1d29631191ea3f27c23495fa06139a5b78 # v3.2.1 | |
| with: | |
| hugo-version: "0.140.2" | |
| extended: true | |
| - name: Generate examples docs | |
| run: make docs-examples | |
| - name: Build site | |
| env: | |
| BASE_URL: ${{ steps.pages.outputs.base_url }} | |
| run: PATH="$PWD/docs/node_modules/.bin:$PATH" hugo --source docs --minify --baseURL "${BASE_URL}/" | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0 | |
| with: | |
| path: docs/public | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0 |