Run on pull requests

.github/workflows/call-deploy-book.yml

@@ -12,6 +12,13 @@ on:
     - book/**
     - requirements.txt
     - .github/workflows/call-deploy-book.yml
+  pull_request:
+    branches:
+    - '**'
+    paths:
+    - book/**
+    - requirements.txt
+    - .github/workflows/call-deploy-book.yml
   workflow_dispatch:
 
 jobs: 

.github/workflows/deploy-book.yml

@@ -41,6 +41,12 @@ env:
   # Space-separated list of branch names, e.g. 'main second third'.
   # By default, deploy all branches. This is indicated by '*'.
   BRANCHES_TO_DEPLOY: ${{ vars.BRANCHES_TO_DEPLOY != '' && vars.BRANCHES_TO_DEPLOY || '*' }}
+
+  # Which pull requests to release
+  # Space-separated list of pull request numbers, e.g. '1 2 3'.
+  # By default, deploy all pull requests. This is indicated by '*'.
+  # If building of pull request is unwanted, PULL_REQUESTS_TO_DEPLOY may be set to ' ' (space).
+  PULL_REQUESTS_TO_DEPLOY: ${{ vars.PULL_REQUESTS_TO_DEPLOY != '' && vars.PULL_REQUESTS_TO_DEPLOY || '*' }}
 
   # Preprocessing is described here: (as described here: https://teachbooks.github.io/TeachBooks/cli/cli.html#teachbooks-build)
   # Space-separated list of branch names, e.g. 'main second third'.
@@ -73,11 +79,22 @@ jobs:
         # If all (*), query all remote branches
         # If not, read from env var
         if [ "$BRANCHES_TO_DEPLOY" == '*' ]; then
-          branches=$(git branch -r | sed 's,\s*origin/,,g' | grep -v '\->')
+          branches=$(git branch -r | sed 's,\s*origin/,,g' | grep -v '\->' | grep -v 'pull/')
         else
           branches=$(echo "$BRANCHES_TO_DEPLOY" | tr ' ' '\n' | grep -E '\S')
         fi
+
+        # Fetch all open pull requests from forks and include their branches
+        if [ "$PULL_REQUESTS_TO_DEPLOY" == '*' ]; then
+          pr_branches=$(gh pr list --state open --json number,headRefName,isCrossRepository --jq '.[] | select(.isCrossRepository) | "refs/pull/" + (.number|tostring) + "/merge"')
+        elif [ "$PULL_REQUESTS_TO_DEPLOY" == ' ' ]; then
+          pr_branches=""
+        else
+          pr_branches=$(echo "$PULL_REQUESTS_TO_DEPLOY" | tr ' ' '\n' | xargs -I {} gh pr view {} --json number,headRefName,isCrossRepository --jq 'select(.isCrossRepository) | "refs/pull/" + (.number|tostring) + "/merge"')
+        fi
 
+        branches=$(echo -e "$branches\n$pr_branches" | grep -E '\S')
+
         # Record branch names (one per line) for alias validation
         echo "$branches" | tr ' ' '\n' > branches.txt
 
@@ -248,7 +265,7 @@ jobs:
     - name: Record build success
       if: success()
       run: |
-        echo ":white_check_mark: \\\`Released\\\`" >> buildstatus.txt
+        echo ":white_check_mark: \\\`Build successful\\\`" >> buildstatus.txt
 
     - name: Make summary of errors, if any
       # run even in case of failure
@@ -268,7 +285,12 @@ jobs:
     - name: Clean branch name of disallowed characters
       if: always()
       run: |
-        echo "MATRIX_BRANCH_NAME_CLEAN=$(echo ${{ matrix.branch }} | tr '/":<>|*?\/\\' '-')" >> $GITHUB_ENV
+        if [[ "${{ matrix.branch }}" =~ refs/pull/([0-9]+)/merge ]]; then
+          CLEAN_BRANCH_NAME="PR-${BASH_REMATCH[1]}"
+        else
+          CLEAN_BRANCH_NAME=$(echo "${{ matrix.branch }}" | tr '/":<>|*?\\' '-')
+        fi
+        echo "MATRIX_BRANCH_NAME_CLEAN=${CLEAN_BRANCH_NAME}" >> $GITHUB_ENV
 
     - name: Upload summary as an artifact
       if: always()
@@ -362,10 +384,23 @@ jobs:
         # https://stackoverflow.com/a/76354104
         url=$(gh api "repos/$GITHUB_REPOSITORY/pages" --jq '.html_url')
 
-        # Clean branch names
-        cat raw.txt | tr '/":<>|*?\/\\' '-' > clean.txt
-        cat clean.txt | xargs -I{} cat _buildstatus/_buildstatus-{}/buildstatus.txt > status.txt
+        # Clean normal branch names
+        grep -v '^refs/pull/' raw.txt | tr '/":<>|*?\\' '-' > clean.txt
+
+        # Include cleaned PR branches
+        grep '^refs/pull/' raw.txt | sed 's|refs/pull/\([0-9]\+\)/merge|PR-\1|' >> clean.txt
+
+        # Generate status.txt
+        if [[ "${{ github.event_name }}" != 'push' && "${{ github.event_name }}" != 'workflow_dispatch' ]]; then
+          cat clean.txt | xargs -I{} sh -c 'echo ":no_entry_sign: \\\`Not updated\\\` $(cat _buildstatus/_buildstatus-{}/buildstatus.txt)" >> status.txt'
+        else
+          cat clean.txt | xargs -I{} cat _buildstatus/_buildstatus-{}/buildstatus.txt > status.txt
+        fi
+
+        # Combine raw, clean, and status into pasted.txt
         paste -d ';' raw.txt clean.txt status.txt > pasted.txt
+
+        # Generate summary.md
         cat pasted.txt |
         while IFS=';' read -r raw clean status; do
           echo "| $raw | <$url$clean> | $status |" >> summary.md
@@ -376,9 +411,11 @@ jobs:
         {
           echo
           echo "#### Legend for build status"
-          echo ":white_check_mark: \\\`Released\\\` - build success, new version released."
-          echo ":red_circle: \\\`Build failed [1]\\\` - build failure, previous version of the book reused."
-          echo ":o: \\\`Build failed [2]\\\` - build failure, no previous version reused."
+          echo ":white_check_mark: \\\`Build successful\\\` - build is successful, new version used."
+          echo ":red_circle: \\\`Build failed [1]\\\` - build has failed, previous version of the book reused."
+          echo ":o: \\\`Build failed [2]\\\` - build has failed, no previous version reused."
+          echo ":no_entry_sign: \\\`Not updated\\\` - deployment is skipped because it's triggered from a forked repository."
+
 
           echo
           echo '#### Primary book at root'
@@ -473,11 +510,13 @@ jobs:
         echo "$HTML_TEMPLATE_404_REDIRECT" | envsubst | tee final/404.html
 
     - name: Upload final Pages artifact
+      if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
       uses: actions/upload-pages-artifact@v3
       with:
         path: "final/"
 
     - name: Deploy to GitHub Pages
+      if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
       id: deployment
       uses: actions/deploy-pages@v4
 

README.md

@@ -9,7 +9,7 @@ The workflow has the following features:
 - Ability to release both private (GitHub Pro, GitHub Team, GitHub Enterprise Cloud, or GitHub Enterprise Server required) and public (GitHub Free is enough) repositories.  
 GitHub Teams is free for teachers as described in the [GitHub documentation](https://docs.github.com/en/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/about-github-education-for-teachers#github-education-features-for-teachers).  
 If you have an organization for your TeachBook on GitHub, link your GitHub team rights to your organization as described on the [GitHub website](https://github.com/team#organizations).
-- Releasing all or a selection of branches, allowing to build a draft version of the TeachBook online which reduces the need for local builds of the book
+- Releasing all or a selection of branches and pull requests, allowing to build a draft version of the TeachBook online which reduces the need for local builds of the book
 - Provides a summary describing where the TeachBook is released, errors in the build process per branch and how the release step is configured
 - Caching of already built books so that it can be partially reused when another branch is released or the next build contains critical errors
 - Caching of python environment to speed up the workflow
@@ -47,6 +47,10 @@ You can adapt the behaviour by setting repository variables as explained [here](
 - `BRANCHES_TO_DEPLOY`  which is set to `*` (all branches) whenever it's not defined in the repository variables.
   - This defines the branches to deploy.
   - It should be a space-separated list of branch names, e.g. 'main second third'.
+- `PULL_REQUESTS_TO_DEPLOY` which is set to `*` (all branches) whenver it's not defined in the repository ariables.
+  - This defines the pull requests to deploy
+  - It should be a space-seperated list of pull request numbers, e.g. '1 2 3'
+  - If building of pull request is unwanted, PULL_REQUESTS_TO_DEPLOY may be set to ' ' (space).
 - `BRANCHES_TO_PREPROCESS` which is to to ` ` (just a space = no branch) whenever it's not defined in the repository variables
   - This defines the branches to preprocess with the [`TeachBooks` package](https://teachbooks.io/TeachBooks/cli/cli.html#cmdoption-teachbooks-build), which removed book-pages and config lines defined with `# START REMOVE FROM RELEASE` and `# END REMOVE FROM RELEASE`
   - It should be a space-separated list of branch names, e.g. 'main second third'.
@@ -70,24 +74,26 @@ Here's an example for a summary for the template book:
 > ### Branches deployed
 > | Branch 🎋 | Link 🔗 | Build status ☑️ |
 > | :--- | :--- | :--- |
-> | main | [https://teachbooks.github.io/template/main](https://teachbooks.github.io/template/main) | ✅ `Released` |
+> | main | [https://teachbooks.github.io/template/main](https://teachbooks.github.io/template/main) | ✅ `Build successful` |
 > | version2 | [https://teachbooks.github.io/template/version2](https://teachbooks.github.io/template/version2) | 🔴 `Build failed [1]` |
 > | version3 | [https://teachbooks.github.io/template/version3](https://teachbooks.github.io/template/version3) | ⭕ `Build failed [2]` |
 > 
 > #### Legend for build status
-> ✅ `Released` - build success, new version released.
+> ✅ `Build successful` - build success, new version used.
 >
 > 🔴 `Build failed [1]` - build failure, previous version of the book reused.
 >
 > ⭕ `Build failed [2]` - build failure, no previous version reused.
 >
+> 🚫 `Not updated` - deployment skipped because triggered from forked repository.
+>
 > #### Primary book at root
-> The book at the website root <https://teachbooks.github.io/template/> redirects to the primary branch `main` (status: ✅ `Released`).
+> The book at the website root <https://teachbooks.github.io/template/> redirects to the primary branch `main` (status: ✅ `Build successful`).
 > 
 > ### Aliases
 > | Alias ➡️ | Target 🎯 | Link 🔗 |  Build status ☑️ |
 > | :--- | :--- | :--- | :---- |
-> | draft | main | [https://teachbooks.github.io/template/draft](https://teachbooks.github.io/template/draft) | ✅ `Released` |
+> | draft | main | [https://teachbooks.github.io/template/draft](https://teachbooks.github.io/template/draft) | ✅ `Build successful` |
 > 
 > ### Preview of build errors & warnings
 > For more details please see the corresponding `build-books` jobs in the left pane.