Skip to content

Set GIT_BRANCH as an env variable for Sphinx docs #1092

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
geographika merged 2 commits into from
Jun 12, 2026
Merged

Set GIT_BRANCH as an env variable for Sphinx docs #1092

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d132d60
Set GIT_BRANCH as an env variable
geographika Jun 12, 2026
87ac387
Echo output
geographika Jun 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ jobs:
python-version: 3.13

- name: Build docs
env:
GIT_BRANCH: ${{ github.ref_name }}
run: |
pip install -r requirements.txt
echo "GIT_BRANCH=$(echo $GITHUB_REF | cut -d '/' -f 3)" >> $GITHUB_ENV
./scripts/ci_build_docs.sh

# Deploy release branch to mapserver.github.io
Expand Down
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ BUILD_LANGUAGES = $(TRANSLATIONS)
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees/$$lang $(SPHINXOPTS) -c . -A language=$$lang -D language=$$lang -A languages='$(LANGUAGES)' -A branch=$(GIT_BRANCH)
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees/$$lang $(SPHINXOPTS) -c . -A language=$$lang -D language=$$lang -A languages='$(LANGUAGES)'

ALLSPHINXOPTSI18N = $(SPHINXOPTS) -c . -a -A language=$$lang -D language=$$lang -A languages='$(LANGUAGES)'

Expand Down
1 change: 1 addition & 0 deletions scripts/ci_build_docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
#!/bin/bash
echo "GIT_BRANCH is: $GIT_BRANCH"

git log -n1 | grep -q "\\[build_pdf\\]"

Expand Down