Skip to content

Commit 344d500

Browse files
author
Lisa Julia Nebel
committed
Change workflow to build for 2025.04 as well
1 parent 4a22cf9 commit 344d500

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

.github/workflows/python_sphinx_docs.yml

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,16 @@ jobs:
1919
uses: actions/checkout@v4
2020
with:
2121
fetch-depth: 0 # Fetch all history for all tags and branches
22-
- name: Get docstrings_common.json from master branch of opm-common
22+
- name: Get docstrings_common.json from master branch of opm-common if we are on master
2323
run: |
24-
curl -L -o python/docstrings_common.json https://raw.githubusercontent.com/OPM/opm-common/master/python/docstrings_common.json
24+
if [ "${{ github.ref_name }}" == "master" ]; then
25+
curl -L -o python/docstrings_common.json https://raw.githubusercontent.com/OPM/opm-common/master/python/docstrings_common.json
26+
fi
2527
- name: Get docstrings_common.json from master branch of opm-simulators
2628
run: |
27-
curl -L -o python/docstrings_simulators.json https://raw.githubusercontent.com/OPM/opm-simulators/master/python/docstrings_simulators.json
29+
if [ "${{ github.ref_name }}" == "master" ]; then
30+
curl -L -o python/docstrings_simulators.json https://raw.githubusercontent.com/OPM/opm-simulators/master/python/docstrings_simulators.json
31+
fi
2832
- name: Get dune.module from master branch of opm-simulators, this is needed for the call to extract_opm_simulators_release in python/sphinx_docs/docs/conf.py.
2933
run: |
3034
curl -L -o dune.module https://raw.githubusercontent.com/OPM/opm-simulators/master/dune.module
@@ -44,18 +48,16 @@ jobs:
4448
mkdir gh-pages
4549
touch gh-pages/.nojekyll
4650
cd sphinx_docs
47-
# Currently we build only docs for the HEAD of the master branch
48-
# Later we can add release tags to the list to get the docs for the releases
49-
# For example: -b "master, release/2024.04/final" will build the docs for
50-
# the master branch and the release/2024.04/final tag
51-
# For the releases, we create snapshots of the docstrings_common.json and docstrings_simulators.json
52-
# and take the ones tracked by git, only for the master, we take the current ones we fetched
53-
# in steps 2 and 3 of this workflow
54-
51+
# To add a new relase to this build system:
52+
# - add the respective branch <your-new-release> on this repository
53+
# - take a snapshot of https://raw.githubusercontent.com/OPM/opm-common/<your-new-release>/python/docstrings_common.json and
54+
# https://raw.githubusercontent.com/OPM/opm-simulators/<your-new-release>/python/docstrings_simulators.json and put them
55+
# in the python folder on that branch
56+
# - add the respective branch <your-new-release> in the commands below
5557
if [ "${{ github.ref_name }}" == "master" ]; then
56-
poetry run sphinx-versioned -m master -b "master" --force --git-root ../../
58+
poetry run sphinx-versioned -m master -b "master release/2025.04" --force --git-root ../../
5759
else
58-
poetry run sphinx-versioned -m master -b "master ${{ github.ref_name }}" --force --git-root ../../
60+
poetry run sphinx-versioned -m master -b "${{ github.ref_name }} master release/2025.04" --force --git-root ../../
5961
fi
6062
- name: Copy documentation to gh-pages
6163
run: |

0 commit comments

Comments
 (0)