ci: build previws for the website on doc changes #6
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 and Preview Manual | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| types: [opened, synchronize, reopened, closed] | |
| paths: | |
| - ".github/workflows/docs-preview.yml" | |
| - "modules/**" | |
| - "docs/**" | |
| # Defining permissions here passes it to all workflows. | |
| # https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github_token | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| issues: write | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| build-preview: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Install Nix | |
| uses: DeterminateSystems/nix-installer-action@main | |
| - uses: DeterminateSystems/magic-nix-cache-action@main | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Set default git branch (to reduce log spam) | |
| run: git config --global init.defaultBranch main | |
| - name: Build documentation packages | |
| run: nix build .#docs-html --print-build-logs | |
| - name: Deploy to GitHub Pages preview | |
| run: | | |
| PR_NUMBER=${{ github.event.pull_request.number }} | |
| BRANCH_NAME="gh-pages" | |
| PREVIEW_DIR="docs-preview-${PR_NUMBER}" | |
| # Clone the gh-pages branch and move to the preview subdirectory | |
| git clone --single-branch --branch $BRANCH_NAME https://github.com/${{ github.repository }} gh-pages | |
| cd gh-pages | |
| mkdir -p $PREVIEW_DIR | |
| # Copy the build files to the preview subdirectory | |
| cp -rvf ../result/share/doc/nvf/* ./$PREVIEW_DIR | |
| # Configure git to use the GitHub Actions token for authentication | |
| git config --global user.name "GitHub Actions" | |
| git config --global user.email "[email protected]" | |
| # Set the GitHub token for authentication | |
| git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }} | |
| # Add and commit the changes | |
| git add . | |
| git commit -m "Deploy PR #${PR_NUMBER} preview" | |
| git push origin $BRANCH_NAME | |
| - name: Set preview URL | |
| id: set-url | |
| run: | | |
| PR_NUMBER=${{ github.event.pull_request.number }} | |
| URL="https:/$${ GITHUB_REPOSITORY_OWNER }}.github.io/nvf/pr-preview-${PR_NUMBER}/" | |
| echo "Live Preview URL: $URL" | |
| echo "::set-output name=url::$URL" | |
| comment-url: | |
| needs: build-preview | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Post live preview comment | |
| uses: peter-evans/create-or-update-comment@v4 | |
| with: | |
| issue-number: ${{ github.event.pull_request.number }} | |
| reactions: "rocket" | |
| body: | | |
| 🚀 **Live preview is ready!** | |
| You can view it here: ${{ needs.build-preview.outputs.url }} | |
| cleanup: | |
| if: github.event.pull_request.merged == true || github.event.pull_request.state == 'closed' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| # The PR is closed, preview is no longer necessary. | |
| - name: Delete preview for closed/merged PR | |
| run: | | |
| PR_NUMBER=${{ github.event.pull_request.number }} | |
| BRANCH_NAME="gh-pages" | |
| PREVIEW_DIR="pr-preview-${PR_NUMBER}" | |
| # Clone the gh-pages branch to delete the preview | |
| git clone --single-branch --branch $BRANCH_NAME https://github.com/${{ github.repository }} gh-pages | |
| cd gh-pages | |
| # Delete the preview directory for the closed/merged PR | |
| rm -rf $PREVIEW_DIR | |
| # Configure git to use the GitHub Actions token for authentication | |
| git config --global user.name "GitHub Actions" | |
| git config --global user.email "[email protected]" | |
| # Set the GitHub token for authentication | |
| git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }} | |
| # Add and commit the changes (deleting the preview directory) | |
| git add . | |
| git commit -m "Remove preview for PR #${PR_NUMBER}" | |
| git push origin $BRANCH_NAME |