Build PR & Deploy #43
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
| name: Build PR & Deploy | |
| on: | |
| workflow_run: | |
| workflows: ["Trigger PR Build"] | |
| types: | |
| - completed | |
| concurrency: | |
| group: pull-request-builds | |
| cancel-in-progress: false | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| actions: read | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| if: github.event.repository.fork == false | |
| outputs: | |
| url: ${{ steps.cloudflare.outputs.deployment-url }} | |
| pr_number: ${{ steps.pr_info.outputs.pr_number }} | |
| pr_sha: ${{ steps.pr_info.outputs.pr_sha }} | |
| steps: | |
| - name: 'Download artifact' | |
| uses: actions/download-artifact@v4 | |
| with: | |
| run-id: ${{ github.event.workflow_run.id }} | |
| github-token: ${{ github.token }} | |
| name: pr_info | |
| path: ${{ github.workspace }}/pr_info | |
| - name: Display structure of downloaded files | |
| run: tree ${{ github.workspace }} | |
| - name: Read PR info | |
| id: pr_info | |
| run: | | |
| echo "pr_number=$(cat ${{ github.workspace }}/pr_info/PR_NUMBER)" >> $GITHUB_OUTPUT | |
| echo "pr_sha=$(cat ${{ github.workspace }}/pr_info/PR_SHA)" >> $GITHUB_OUTPUT | |
| - name: Checkout repo | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ steps.pr_info.outputs.pr_sha }} | |
| fetch-depth: 0 | |
| - name: Setup Python 3 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.x' | |
| - name: Restore cache | |
| id: cache-docs-restore | |
| uses: actions/cache/restore@v4 | |
| with: | |
| key: docs-${{ steps.pr_info.outputs.pr_number }} | |
| path: .cache | |
| restore-keys: | | |
| docs-${{ steps.pr_info.outputs.pr_number }} | |
| - name: Install dependencies | |
| run: sudo apt-get install pngquant | |
| - name: Install wheel | |
| run: pip install wheel | |
| - name: Install mkdocs material insiders | |
| run: | | |
| pip install git+https://${{ secrets.GH_TOKEN }}@github.com/chazlarson/automaticSpoon.git | |
| pip install mkdocs-material[recommended,git,imaging] | |
| - name: Install requirements.txt | |
| run: pip install -r requirements.txt | |
| - name: Build mkdocs | |
| run: | | |
| mkdocs build --clean | |
| mkdocs --version | |
| env: | |
| CI: true | |
| - name: Publish to Cloudflare Pages | |
| id: cloudflare | |
| uses: cloudflare/wrangler-action@v3 | |
| with: | |
| apiToken: ${{ secrets.CF_API_TOKEN }} | |
| accountId: ${{ secrets.CF_ACCOUNT_ID }} | |
| command: > | |
| pages deploy site | |
| --project-name=docs | |
| --branch=pr-${{ steps.pr_info.outputs.pr_number }} | |
| --commit-hash=${{ steps.pr_info.outputs.pr_sha }} | |
| - name: Save build cache | |
| id: cache-docs-save | |
| uses: actions/cache/save@v4 | |
| with: | |
| path: .cache | |
| key: docs-${{ steps.pr_info.outputs.pr_number }}-${{ github.run_id }} | |
| comment: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| if: github.event.repository.fork == false | |
| steps: | |
| - name: Checkout repo | |
| uses: actions/checkout@v4 | |
| - name: Get PR last commit SHA | |
| run: | | |
| PR_DATA=$(curl -H "Authorization: token ${{ secrets.GH_TOKEN }}" \ | |
| -H "Accept: application/vnd.github.v3+json" \ | |
| "https://api.github.com/repos/${{ github.repository }}/pulls/${{ needs.build.outputs.pr_number }}") | |
| LAST_COMMIT_SHA=$(echo "$PR_DATA" | jq -r .head.sha) | |
| echo "LAST_COMMIT_SHA=$LAST_COMMIT_SHA" >> $GITHUB_ENV | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GH_TOKEN }} | |
| - name: Comment PR | |
| run: | | |
| PREVIEW_URL=${{ needs.build.outputs.url }} | |
| BRANCH_PREVIEW_URL="https://pr-${{ needs.build.outputs.pr_number }}.docs-acq.pages.dev" | |
| BUILD_STATUS=${{ needs.build.result }} | |
| if [ "$BUILD_STATUS" == "success" ]; then | |
| STATUS_EMOJI="✅" | |
| STATUS_MESSAGE="Deploy successful!" | |
| else | |
| STATUS_EMOJI="❌" | |
| STATUS_MESSAGE="Build failed!" | |
| fi | |
| COMMENT_BODY="Deploying with ⚡ Cloudflare Pages<br><table><tr><td><strong>Latest commit:</strong></td><td><code>$LAST_COMMIT_SHA</code></td></tr><tr><td><strong>Status:</strong></td><td> $STATUS_EMOJI $STATUS_MESSAGE</td></tr><tr><td><strong>Preview URL:</strong></td><td><a href='$PREVIEW_URL'>$PREVIEW_URL</a></td></tr><tr><td><strong>Branch Preview URL:</strong></td><td><a href='$BRANCH_PREVIEW_URL'>$BRANCH_PREVIEW_URL</a></td></tr></table>" | |
| ESCAPED_BODY=$(echo "$COMMENT_BODY" | jq -aRs .) | |
| COMMENTS_URL="https://api.github.com/repos/${{ github.repository }}/issues/${{ needs.build.outputs.pr_number }}/comments" | |
| curl -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \ | |
| -H "Accept: application/vnd.github+json" \ | |
| -X POST \ | |
| -d "{\"body\": $ESCAPED_BODY }" \ | |
| $COMMENTS_URL | |
| webhook: | |
| name: 'webhook' | |
| runs-on: ubuntu-latest | |
| needs: build | |
| if: always() && github.event.repository.fork == false | |
| steps: | |
| - name: Checkout repo | |
| uses: actions/checkout@v4 | |
| - name: Determine Workflow Conclusion | |
| run: ./scripts/workflow-status.sh ${{ secrets.GITHUB_TOKEN }} ${{ github.repository }} ${{ github.run_id }} | |
| - name: Send Discord Notification | |
| uses: sarisia/actions-status-discord@v1 | |
| with: | |
| webhook: ${{ secrets.DISCORD_WEBHOOK }} | |
| description: "URL: ${{ needs.build.outputs.url }}" | |
| status: ${{ env.WORKFLOW_CONCLUSION }} |