Add developer guide documentation build workflow #1
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: Build Developer Guide Docs | |
| on: | |
| pull_request: | |
| paths: | |
| - 'docs/developer-guide/**' | |
| - '.github/workflows/developer-guide-docs.yml' | |
| release: | |
| types: [published] | |
| workflow_dispatch: | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| issues: write | |
| pull-requests: write | |
| actions: read | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Ruby | |
| uses: ruby/setup-ruby@v1 | |
| with: | |
| ruby-version: '3.1' | |
| - name: Install Asciidoctor tooling | |
| run: | | |
| gem install --no-document asciidoctor asciidoctor-pdf | |
| - name: Build Developer Guide HTML and PDF | |
| run: | | |
| OUTPUT_DIR="build/developer-guide" | |
| mkdir -p "$OUTPUT_DIR" | |
| asciidoctor -D "$OUTPUT_DIR" -o developer-guide.html docs/developer-guide/developer-guide.asciidoc | |
| asciidoctor-pdf -D "$OUTPUT_DIR" -o developer-guide.pdf docs/developer-guide/developer-guide.asciidoc | |
| - name: Upload HTML artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: developer-guide-html | |
| path: build/developer-guide/developer-guide.html | |
| if-no-files-found: error | |
| - name: Upload PDF artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: developer-guide-pdf | |
| path: build/developer-guide/developer-guide.pdf | |
| if-no-files-found: error | |
| - name: Comment with artifact download links | |
| if: ${{ github.event_name == 'pull_request' }} | |
| uses: actions/github-script@v7 | |
| with: | |
| github-token: ${{ secrets.GITHUB_TOKEN }} | |
| script: | | |
| const marker = '<!-- developer-guide-artifacts -->'; | |
| const { owner, repo } = context.repo; | |
| const runId = context.runId; | |
| const artifacts = await github.rest.actions.listWorkflowRunArtifacts({ | |
| owner, | |
| repo, | |
| run_id: runId, | |
| per_page: 100 | |
| }); | |
| const links = []; | |
| for (const artifact of artifacts.data.artifacts) { | |
| if (artifact.name === 'developer-guide-html') { | |
| links.push(`- [Developer Guide HTML](https://github.com/${owner}/${repo}/actions/runs/${runId}/artifacts/${artifact.id})`); | |
| } | |
| if (artifact.name === 'developer-guide-pdf') { | |
| links.push(`- [Developer Guide PDF](https://github.com/${owner}/${repo}/actions/runs/${runId}/artifacts/${artifact.id})`); | |
| } | |
| } | |
| if (!links.length) { | |
| console.log('No artifacts found to report.'); | |
| return; | |
| } | |
| const body = `${marker}\nDeveloper Guide build artifacts are available for download from this workflow run:\n\n${links.join('\n')}\n`; | |
| const comments = await github.rest.issues.listComments({ | |
| owner, | |
| repo, | |
| issue_number: context.issue.number, | |
| per_page: 100 | |
| }); | |
| const existing = comments.data.find(comment => comment.body && comment.body.includes(marker)); | |
| if (existing) { | |
| await github.rest.issues.updateComment({ | |
| owner, | |
| repo, | |
| comment_id: existing.id, | |
| body | |
| }); | |
| } else { | |
| await github.rest.issues.createComment({ | |
| owner, | |
| repo, | |
| issue_number: context.issue.number, | |
| body | |
| }); | |
| } | |
| - name: Attach artifacts to release | |
| if: ${{ github.event_name == 'release' && github.event.action == 'published' }} | |
| uses: softprops/action-gh-release@v1 | |
| with: | |
| files: | | |
| build/developer-guide/developer-guide.html | |
| build/developer-guide/developer-guide.pdf |