Design work #218
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 and deploy the dataplane design documentation. | |
| # Publish a new version of the docs for pushes to "main", or deploy a preview | |
| # when the workflow runs for a Pull Request. | |
| name: "docs.yml" | |
| on: | |
| pull_request: {} | |
| push: | |
| branches: | |
| - "main" | |
| merge_group: | |
| types: ["checks_requested"] | |
| workflow_dispatch: | |
| inputs: | |
| debug_enabled: | |
| type: "boolean" | |
| description: "Run with tmate enabled" | |
| required: false | |
| default: false | |
| concurrency: | |
| group: "${{ github.workflow }}:${{ github.event.pull_request.number || github.event.after }}" | |
| cancel-in-progress: true | |
| permissions: | |
| contents: "read" | |
| pages: "write" | |
| id-token: "write" | |
| pull-requests: "read" | |
| statuses: "write" | |
| jobs: | |
| check_changes: | |
| name: "Deduce required tests from code changes" | |
| runs-on: "ubuntu-latest" | |
| outputs: | |
| docs: "${{ steps.changes.outputs.docs }}" | |
| steps: | |
| - name: "Checkout" | |
| if: "${{ !github.event.pull_request }}" | |
| uses: "actions/checkout@v4" | |
| with: | |
| persist-credentials: "false" | |
| fetch-depth: "0" | |
| - name: "Check code changes" | |
| uses: "dorny/paths-filter@v3" | |
| id: "changes" | |
| with: | |
| filters: | | |
| docs: | |
| - 'design-docs/**' | |
| - '.github/workflows/docs.yml' | |
| - 'scripts/dpdk-sys.env' | |
| build: | |
| name: "Build and deploy documentation" | |
| needs: [ check_changes ] | |
| if: "${{ needs.check_changes.outputs.docs == 'true' || github.event_name == 'workflow_dispatch' }}" | |
| runs-on: "ubuntu-latest" | |
| steps: | |
| - uses: "cargo-bins/cargo-binstall@main" | |
| - run: | | |
| cargo binstall --no-confirm just | |
| - name: "Checkout" | |
| uses: "actions/checkout@v4" | |
| - name: "Extract branch name" | |
| shell: "bash" | |
| run: | | |
| echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT | |
| id: "extract_branch" | |
| - name: "Extract git hash" | |
| shell: "bash" | |
| run: | | |
| echo "git_hash=${GITHUB_SHA}" >> $GITHUB_OUTPUT | |
| id: "extract_hash" | |
| - name: "Build design docs" | |
| run: | | |
| just debug=true mdbook build | |
| - name: "Copy design doc build to publish directory" | |
| run: | | |
| set -euxo pipefail | |
| mkdir --parent "${{ github.workspace }}/publish/" | |
| cp -r ./design-docs/src/mdbook/book "${{ github.workspace }}/publish/design-docs" | |
| - name: "(Push) Setup Pages" | |
| if: "${{ !github.event.pull_request && !github.event_name == 'merge_group' }}" | |
| uses: "actions/configure-pages@v5" | |
| - name: "(Push) Upload design-docs" | |
| if: "${{ !github.event.pull_request && !github.event_name == 'merge_group' }}" | |
| uses: "actions/upload-pages-artifact@v3" | |
| with: | |
| # Upload design-docs build directory content | |
| path: 'publish/design-docs' | |
| - name: "(Push) Deploy to GitHub Pages" | |
| if: "${{ !github.event.pull_request && !github.event_name == 'merge_group' }}" | |
| id: "deployment" | |
| uses: "actions/deploy-pages@v4" | |
| env: | |
| GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" | |
| - name: "(PR) Deploy documentation preview" | |
| if: "${{ github.event.pull_request }}" | |
| uses: "nwtgck/actions-netlify@v2" | |
| with: | |
| publish-dir: "${{ github.workspace }}/publish/design-docs" | |
| alias: "preview-${{ github.event.number }}" | |
| deploy-message: "${{ github.event.pull_request.title }}" | |
| github-token: "${{ secrets.GITHUB_TOKEN }}" | |
| fails-without-credentials: "true" | |
| enable-commit-status: "true" | |
| enable-pull-request-comment: "false" | |
| enable-commit-comment: "false" | |
| enable-github-deployment: "false" | |
| env: | |
| NETLIFY_AUTH_TOKEN: "${{ secrets.NETLIFY_AUTH_TOKEN }}" | |
| NETLIFY_SITE_ID: "${{ secrets.NETLIFY_SITE_ID }}" | |
| timeout-minutes: 5 | |
| - name: "Setup tmate session for debug" | |
| if: ${{ failure() && github.event_name == 'workflow_dispatch' && inputs.debug_enabled }} | |
| uses: "mxschmitt/action-tmate@v3" | |
| timeout-minutes: 60 | |
| with: | |
| limit-access-to-actor: true |