Skip to content

Test doxygen on alma10 #22321

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

Draft
hageboeck wants to merge 7 commits into
base: master
Choose a base branch
from
+46 −92
Draft

Test doxygen on alma10 #22321

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2d22e1e
[ci] Move doxygen job to alma10.
hageboeck May 18, 2026
24814a0
[ci] Remove the override step from the doxygen job.
hageboeck May 18, 2026
a55a90d
[ci] Remove duplicated build step for doxygen job.
hageboeck May 18, 2026
42b7b41
[ci][docs] Allow for choosing an eos upload directory.
hageboeck May 18, 2026
708f66e
[ci][docs] Make actionlint and shellcheck happier with the workflow.
hageboeck May 18, 2026
77de818
[ci][docs] Add a pull request trigger for the doxygen CI job.
hageboeck May 18, 2026
36707c3
WIP: Fix input parsing
hageboeck May 18, 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
138 changes: 46 additions & 92 deletions .github/workflows/root-docs-ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
name: 'ROOT Docs CI'

on:
pull_request:
paths:
- '.github/workflows/root-docs-ci.yml'
- 'documentation/doxygen/**'
branches:
- 'master'

# Allows nightly builds to trigger one run for each branch easily, by
# providing the relevant branch as "default" value here:
workflow_call:
inputs:
incremental:
Expand All @@ -17,11 +21,16 @@ on:
type: boolean
required: false
default: false
# docu_input: # opportunity: overwrite makeinput.sh with these args
# description: Folders to build documentation for. All folders are built if empty.
# type: string
# default: ""
# required: false
input_branch:
description: 'Which branch to build documentation for'
type: string
required: false
default: 'master'
eos_upload_directory:
description: 'Make documentation available at <root-website>/doc/<directory>. Leave empty for skipping the upload to eos.'
type: string
required: false
default: 'master'

jobs:
build-docs:
Expand All @@ -33,19 +42,22 @@ jobs:
- x64

env:
PLATFORM: alma9
PLATFORM: alma10
DOC_DIR: master
DOC_LOCATION: /github/home
BASE_REF: master
WEB_DIR_NAME: master
BASE_REF: ${{ inputs.input_branch != null && inputs.input_branch || 'master' }}
WEB_DIR_NAME: ${{ inputs.eos_upload_directory != null && inputs.eos_upload_directory || '' }}
TAR_NAME: htmlmaster.tar
OVERRIDES: "testing=Off roottest=Off"

permissions:
contents: read

container:
image: registry.cern.ch/root-ci/alma9:buildready
image: registry.cern.ch/root-ci/alma10:buildready
options: '--security-opt label=disable --rm'
volumes:
- alma10_ccache_volume:/github/home/.cache/ccache
env:
OS_APPLICATION_CREDENTIAL_ID: '7f5b64a265244623a3a933308569bdba'
OS_APPLICATION_CREDENTIAL_SECRET: ${{ secrets.OS_APPLICATION_CREDENTIAL_SECRET }}
Expand Down Expand Up @@ -74,79 +86,26 @@ jobs:
echo TAR_NAME=html${BASE_REF}.tar >> $GITHUB_ENV
echo DOCDIR_NAME=${BASE_REF} >> $GITHUB_ENV

# TODO: install latest versions in image on root-ci-images
- name: Install Doxygen 1.10.0
run : |
mkdir -p ${{ github.workspace }}/doxygen
curl -L https://github.com/doxygen/doxygen/releases/download/Release_1_10_0/doxygen-1.10.0.linux.bin.tar.gz | tar -xz -C ${{ github.workspace }}/doxygen/ --strip-components=1
echo PATH=$PATH:${{ github.workspace }}/doxygen/bin >> $GITHUB_ENV
# git clone --branch Release_1_12_0 https://github.com/doxygen/doxygen.git
# cd doxygen
# mkdir build
# cd build
# cmake ..
# make -j$(nproc)
# echo PATH=$PATH:${{ github.workspace }}/doxygen/build/bin >> $GITHUB_ENV
# cd ${{ github.workspace }}
# doxygen --version

- name: Install qhelpgenerator-qt5
run: |
dnf upgrade -y
dnf install -y qt5-doctools
which qhelpgenerator-qt5

- name: Apply option overrides
env:
OVERRIDES: "testing=Off roottest=Off"
CONFIGFILE: '.github/workflows/root-ci-config/buildconfig/alma9.txt'
shell: bash
run: |
set -x
echo '' >> "$CONFIGFILE"
for ENTRY in $OVERRIDES; do
KEY=$( echo "$ENTRY" | cut -d '=' -f 1 )
# Add entry to file if not exists, otherwise replace
if grep -q "$KEY=" "$CONFIGFILE"; then
sed -i "s/$KEY=.*\$/$ENTRY/" "$CONFIGFILE"
else
echo "$ENTRY" >> "$CONFIGFILE"
fi
done
cat "$CONFIGFILE" || true

- name: Build ROOT - Workflow Dispatch
if: github.event_name == 'workflow_dispatch'
env:
INCREMENTAL: ${{ inputs.incremental == 'true' }}
run: ".github/workflows/root-ci-config/build_root.py
--buildtype Release
--platform ${{ env.PLATFORM }}
--incremental ${{ env.INCREMENTAL }}
--base_ref ${BASE_REF}
--head_ref ${BASE_REF}
--binaries false
--repository ${{ github.server_url }}/${{ github.repository }}"

- name: Build ROOT - Schedule
if: github.event_name == 'schedule'
- name: Build ROOT
run: ".github/workflows/root-ci-config/build_root.py
--buildtype Release
--platform ${{ env.PLATFORM }}
--incremental ${{ inputs.incremental }}
--incremental ${{ inputs.incremental == null && 'false' || inputs.incremental }}
--base_ref ${BASE_REF}
--head_ref ${BASE_REF}
--binaries false
--repository ${{ github.server_url }}/${{ github.repository }}"
--repository ${{ github.server_url }}/${{ github.repository }}
--overrides ${OVERRIDES}
--upload_artifacts false
--binaries false"

- name: Run Doxygen
working-directory: ${{ env.DOC_LOCATION }}
shell: bash
run: |
source ROOT-CI/build/bin/thisroot.sh
export DOXYGEN_OUTPUT_DIRECTORY=/github/home/${DOC_DIR}
export DOXYGEN_OUTPUT_DIRECTORY="/github/home/${DOC_DIR}"
cd ROOT-CI/src/documentation/doxygen
make -j `nproc --all`
make -j "$(nproc --all)"

- name: Create documentation archives
working-directory: ${{ env.DOC_LOCATION }}
Expand All @@ -170,13 +129,8 @@ jobs:
path: ${{env.DOC_LOCATION}}/${{env.TAR_NAME}}.gz
if-no-files-found: error

- name: Install Kerberos utilities
run: dnf -y install krb5-workstation

- name: Install XRootD client
run: dnf -y install xrootd-client

- name: Sync documentation to EOS
if: ${{ env.WEB_DIR_NAME != null && env.WEB_DIR_NAME != '' }}
env:
RWEBEOS_KT: ${{ secrets.RWEBEOS_KT }}
KRB5USER: ${{ secrets.KRB5USER }}
Expand All @@ -191,20 +145,20 @@ jobs:
# them by extension. Once that is fixed in XRootD, a single command can be used
# instead.
run: |
echo ${RWEBEOS_KT} | base64 -d > ${KT_FILE_NAME}
kinit -p ${{ secrets.KRB5USER }}@${{ secrets.KRB5REALM }} -kt ${KT_FILE_NAME}
cd ${DOC_DIR}/html/
xrdcp --parallel 64 -rf ./*.html ${EOS_ENDPOINT}/${EOS_BASE_PATH}/doc/${WEB_DIR_NAME}
rm -rf *.html
xrdcp --parallel 64 -rf ./*.svg ${EOS_ENDPOINT}/${EOS_BASE_PATH}/doc/${WEB_DIR_NAME}
rm -rf *.svg
xrdcp --parallel 64 -rf ./*.map ${EOS_ENDPOINT}/${EOS_BASE_PATH}/doc/${WEB_DIR_NAME}
rm -rf *.map
xrdcp --parallel 64 -rf ./*.md5 ${EOS_ENDPOINT}/${EOS_BASE_PATH}/doc/${WEB_DIR_NAME}
rm -rf *.md5
xrdcp --parallel 64 -rf ./ ${EOS_ENDPOINT}/${EOS_BASE_PATH}/doc/${WEB_DIR_NAME}
echo "${RWEBEOS_KT}" | base64 -d > "${KT_FILE_NAME}"
kinit -p "${{ secrets.KRB5USER }}@${{ secrets.KRB5REALM }}" -kt "${KT_FILE_NAME}"
cd "${DOC_DIR}/html/"
xrdcp --parallel 64 -rf ./*.html "${EOS_ENDPOINT}/${EOS_BASE_PATH}/doc/${WEB_DIR_NAME}"
rm -rf ./*.html
xrdcp --parallel 64 -rf ./*.svg "${EOS_ENDPOINT}/${EOS_BASE_PATH}/doc/${WEB_DIR_NAME}"
rm -rf ./*.svg
xrdcp --parallel 64 -rf ./*.map "${EOS_ENDPOINT}/${EOS_BASE_PATH}/doc/${WEB_DIR_NAME}"
rm -rf ./*.map
xrdcp --parallel 64 -rf ./*.md5 "${EOS_ENDPOINT}/${EOS_BASE_PATH}/doc/${WEB_DIR_NAME}"
rm -rf ./*.md5
xrdcp --parallel 64 -rf ./ "${EOS_ENDPOINT}/${EOS_BASE_PATH}/doc/${WEB_DIR_NAME}"
cd ..
rm -r html
xrdcp --parallel 64 -rf ./ ${EOS_ENDPOINT}/${EOS_BASE_PATH}/doc/${WEB_DIR_NAME}
xrdcp --parallel 64 -rf ./ "${EOS_ENDPOINT}/${EOS_BASE_PATH}/doc/${WEB_DIR_NAME}"
cd ..
xrdcp -rf ${TAR_NAME}.gz ${EOS_ENDPOINT}/${EOS_BASE_PATH}/download
xrdcp -rf "${TAR_NAME}.gz" "${EOS_ENDPOINT}/${EOS_BASE_PATH}/download"
Loading