Merge pull request #19 from hakonhagland/fork-friendly-doc-workflow

Make documentation workflow fork-friendly with dynamic branch detection

Author: blattms

.github/workflows/python_sphinx_docs.yml

@@ -53,19 +53,20 @@ jobs:
             mkdir gh-pages
             touch gh-pages/.nojekyll
             cd sphinx_docs
-            # To add a new relase to this build system:
+            # To add a new release to this build system:
             # - add the respective branch <your-new-release> on this repository, replace the slashes "/" by dashes "-"
             #   (slashes mess with the navigation html created by sphinx-versioned)
             # - take a snapshot of https://raw.githubusercontent.com/OPM/opm-common/<your-new-release>/python/docstrings_common.json,
             #   https://raw.githubusercontent.com/OPM/opm-simulators/<your-new-release>/python/docstrings_simulators.json and
             #   https://raw.githubusercontent.com/OPM/opm-simulators/<your-new-release>/dune.module and put them
             #   in the python folder on that branch
-            # - add the respective branch <your-new-release> in the command below
-            if [ "${{ github.ref_name }}" == "master" ]; then
-              poetry run sphinx-versioned -m master -b "master release-2025.04" --force --git-root ../../
-            else
-              poetry run sphinx-versioned -m master -b "${{ github.ref_name }} master release-2025.04" --force --git-root ../../
-            fi
+            # Once created, the script below will automatically detect and include the new release branch
+
+            # Dynamically determine which branches to build documentation for
+            # This allows the workflow to work on forks that may not have all release branches
+            BRANCHES=$(../scripts/get_doc_branches.sh "${{ github.ref_name }}")
+            echo "Building documentation for branches: $BRANCHES"
+            poetry run sphinx-versioned -m master -b "$BRANCHES" --force --git-root ../../
         - name: Copy documentation to gh-pages
           run: |
             cp -r python/sphinx_docs/docs/_build/* python/gh-pages

python/scripts/get_doc_branches.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+# Script to dynamically determine which branches to build documentation for
+# This makes the workflow work on forks that may not have all release branches
+#
+# Usage: get_doc_branches.sh <current_branch_name>
+#
+# Returns: Space-separated list of branches for sphinx-versioned
+
+set -e
+
+CURRENT_BRANCH="$1"
+
+if [ -z "$CURRENT_BRANCH" ]; then
+    echo "Error: Current branch name must be provided as first argument" >&2
+    exit 1
+fi
+
+# Initialize branch list with current branch
+BRANCHES="$CURRENT_BRANCH"
+
+# Add master if it exists and isn't already in the list
+if git ls-remote --heads origin master >/dev/null 2>&1; then
+    if [ "$CURRENT_BRANCH" != "master" ]; then
+        BRANCHES="$BRANCHES master"
+    fi
+fi
+
+# Add all release branches that exist
+# Note: We check for remote branches to handle forks properly
+for branch in $(git ls-remote --heads origin | grep -E 'refs/heads/release-' | sed 's/.*refs\/heads\///'); do
+    # Skip if already in list (shouldn't happen with release branches, but be safe)
+    if [[ ! " $BRANCHES " =~ " $branch " ]]; then
+        BRANCHES="$BRANCHES $branch"
+    fi
+done
+
+# Output the branch list
+echo "$BRANCHES"