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: "Rebuild and deploy PR and diff versions of a website to gh-pages branch" | |
| # YOUR_FILES below should be replaced with a list of files that, when changed in a PR, will trigger the PR deploy preview | |
| on: | |
| pull_request: | |
| types: [opened, synchronize] | |
| paths: | |
| - 'textbook/**' | |
| branches: | |
| - 'main' | |
| jobs: | |
| deploy-pr-preview: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| packages: write | |
| pull-requests: write | |
| steps: | |
| # Checkout a copy of the repository on the PR branch | |
| - name: Checkout the PR version of the website repository | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: '0' | |
| ref: ${{ github.head_ref }} | |
| # Build the PR version of the website | |
| # YOUR_BUILD_CODE below should be replaced with code that builds your website | |
| - name: Build the PR version of the website | |
| uses: quarto-dev/quarto-actions/setup@v2 | |
| - uses: r-lib/actions/setup-r@v2 | |
| - uses: r-lib/actions/setup-r-dependencies@v2 | |
| with: | |
| cache: 2 | |
| extra-packages: | | |
| any::knitr | |
| any::rmarkdown | |
| any::downlit | |
| any::xml2 | |
| - uses: quarto-dev/quarto-actions/render@v2 | |
| with: | |
| path: textbook | |
| # Push the PR version of the website to the gh-pages branch | |
| # the PR version will be stored in a folder named pull### (where ### is the PR number) | |
| # WEBSITE_FOLDER below should be replaced with the folder in which the newly built website was stored | |
| - name: Push the PR version of the website to gh-pages branch | |
| uses: peaceiris/actions-gh-pages@v3.8.0 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: _book | |
| keep_files: true | |
| destination_dir: pull${{ github.event.number }} | |
| # Now that the website was built and pushed to gh-pages, checkout the gh-pages branch | |
| - name: Checkout the gh-pages branch | |
| uses: actions/checkout@v2 | |
| with: | |
| fetch-depth: '0' | |
| ref: 'gh-pages' | |
| # Compute the diff of the new PR website (which is stored in the pull### folder) | |
| # Store the diff version of the website in a folder named diff### (where ### is the PR number) | |
| # OLD_SITE_FOLDER below should be replaced with the folder where the "base" version of the website is stored | |
| - name: Run website diff to compare the old site to the PR version | |
| run: | | |
| rustup update | |
| pip install --upgrade pip | |
| pip install website_diff | |
| ls -la | |
| website_diff --old _book --new pull${{ github.event.number }} --diff diff${{ github.event.number }} | |
| # Push the diff version of the website to the gh-pages branch | |
| # the diff version will be stored in a folder named diff### (where ### is the PR number) | |
| - name: Push the diff version of the website to the gh-pages branch | |
| uses: peaceiris/actions-gh-pages@v3.8.0 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: diff${{ github.event.number }} | |
| keep_files: true | |
| destination_dir: diff${{ github.event.number }} | |
| # Post a message on the PR thread with links to the PR preview, the diff, the base version, and the production version of the website | |
| # YOUR_SITE below should be replaced with your website's URL | |
| # OLD_SITE_FOLDER should be replaced with the folder where the "base" version of the website is stored | |
| - name: Post PR preview, diff, current main, and production URLS to PR thread | |
| uses: mshick/add-pr-comment@v2.8.1 | |
| with: | |
| message: | | |
| Hello! I've built a preview of your PR so that you can compare it to the current `main` branch. | |
| * PR deploy preview available [here](https://YOUR_SITE.com/pull${{ github.event.number }}/index.html) | |
| * PR diff with `main` available [here](https://YOUR_SITE.com/diff${{ github.event.number }}/index.html) | |
| * Current `main` deploy preview available [here](https://YOUR_SITE.com/OLD_SITE_FOLDER/index.html) | |
| * Public production build available [here](https://YOUR_SITE.com) |