Use multicore batching by default #633
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/**" | |
| - "CHANGELOG.md" | |
| - "CONTRIBUTING.md" | |
| - "SECURITY.md" | |
| - "BENCHMARKS.md" | |
| - "Cargo.toml" | |
| - ".github/workflows/docs.yml" | |
| pull_request: | |
| branches: [main] | |
| paths: | |
| - "docs/**" | |
| - "CHANGELOG.md" | |
| - "CONTRIBUTING.md" | |
| - "SECURITY.md" | |
| - "BENCHMARKS.md" | |
| - "Cargo.toml" | |
| - ".github/workflows/docs.yml" | |
| workflow_dispatch: | |
| permissions: {} # least-privilege default; per-job overrides below | |
| concurrency: | |
| group: docs-${{ github.ref }} | |
| cancel-in-progress: true | |
| env: | |
| NODE_VERSION: "20" | |
| jobs: | |
| # Verify the docs build on every PR and push, without deploying. Catches | |
| # broken links, unresolved macros, and missing-page references that | |
| # `docmd validate` would fail on. | |
| build: | |
| name: Build docs | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read # checkout repo (and read CHANGELOG/SECURITY/CONTRIBUTING for include-markdown) | |
| defaults: | |
| run: | |
| working-directory: docs # the docmd project (config, package.json, plugin) lives here | |
| steps: | |
| - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | |
| with: | |
| persist-credentials: false | |
| fetch-depth: 0 # git plugin needs full history for last-updated timestamps | |
| - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 | |
| with: | |
| node-version: ${{ env.NODE_VERSION }} | |
| cache: npm | |
| cache-dependency-path: docs/package-lock.json | |
| - name: Install docs deps | |
| run: npm ci | |
| - name: Build site | |
| run: npm run docs:build | |
| - name: Validate links | |
| run: npm run docs:validate | |
| - name: Upload Pages artifact | |
| if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request' | |
| uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0 | |
| with: | |
| path: docs/site/ | |
| # Deploy the artifact uploaded by the build job. Only runs on main, and only | |
| # when the build job actually uploaded an artifact. | |
| deploy: | |
| name: Deploy to GitHub Pages | |
| if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request' | |
| needs: build | |
| runs-on: ubuntu-latest | |
| permissions: | |
| pages: write # publish to Pages | |
| id-token: write # Pages deploy uses OIDC for attestation | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0 | |
| - id: deployment | |
| uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0 |