mirror of
https://github.com/HDFGroup/hdf5.git
synced 2026-09-25 04:09:44 +03:00
Scot Breitenfeld
a46a399230
Addresses the "multiple @ param documentation sections" warnings are caused by the interaction of three things:
1. MACRO_EXPANSION = YES with EXPAND_ONLY_PREDEF = NO in Doxyfile.in
2. Versioned API macros in H5version.h like:
\def documentation in APIVersions.dox like:
3. \def H5Tarray_create \api_vers_2{H5Tarray_create,H5Tarray_create1,H5Tarray_create2}
Because Doxygen expands all macros, it sees H5Tarray_create as an alias for H5Tarray_create1. It then associates documentation from both the \def block (for the macro) and the function's own doc block (with \param entries) with the same function — resulting in "multiple @ param documentation sections."
* Update Doxygen version from 1.16.0 to 1.16.1
Use Doxygen 1.16.1 for all platforms. This version includes the latest
bug fixes and improvements while maintaining compatibility with our
documentation format.
* Fix Windows Doxygen installation for version 1.16.1
Handle different Windows binary naming conventions across Doxygen versions:
- 1.16.1 uses: doxygen-VERSION.windows.x64.bin.zip
- 1.16.0 uses: doxygen-VERSION.x64.bin.zip
Try the newer naming convention first, then fall back to the older one
if the download fails. This ensures compatibility across versions.
* Use ssciwr/doxygen-install in setup-doxygen action
Replace direct installation of official Doxygen binaries with
ssciwr/doxygen-install action. This avoids Java documentation parsing
errors that occur with official binaries but not with distribution
builds.
The setup-doxygen action now serves as a thin wrapper around
ssciwr/doxygen-install@f13be16c83 (v1),
using commit hash for security and reproducibility.
* Remove redundant version specification from workflows
The setup-doxygen action already has a default version (1.16.1),
so explicit version specification in workflows is unnecessary.
This follows DRY principles and makes version updates simpler.
367 lines
12 KiB
YAML
367 lines
12 KiB
YAML
name: hdf5 Developer Mode CI
|
|
|
|
on:
|
|
workflow_call:
|
|
inputs:
|
|
file_base:
|
|
description: "The common base name of the source tarballs"
|
|
required: true
|
|
type: string
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
env:
|
|
CTEST_OUTPUT_ON_FAILURE: 1
|
|
|
|
jobs:
|
|
linux_build_and_test:
|
|
name: "Linux Developer Mode Express Test Workflows"
|
|
|
|
# Don't run the action if the commit message says to skip CI
|
|
if: "!contains(github.event.head_commit.message, 'skip-ci')"
|
|
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Set file base name (Windows)
|
|
id: set-file-base
|
|
run: |
|
|
FILE_NAME_BASE=$(echo "${{ inputs.file_base }}")
|
|
echo "FILE_BASE=$FILE_NAME_BASE" >> $GITHUB_OUTPUT
|
|
|
|
- name: Get Actions
|
|
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
|
|
with:
|
|
sparse-checkout: .github/actions
|
|
|
|
- name: Setup Doxygen
|
|
uses: ./.github/actions/setup-doxygen
|
|
|
|
- name: Install Linux Dependencies
|
|
run: |
|
|
sudo apt-get update
|
|
sudo apt-get install ninja-build graphviz
|
|
sudo apt install libssl3 libssl-dev libcurl4 libcurl4-openssl-dev
|
|
sudo apt install libaec0 libaec-dev
|
|
sudo apt install gcc-12 g++-12 gfortran-12
|
|
echo "CC=gcc-12" >> $GITHUB_ENV
|
|
echo "CXX=g++-12" >> $GITHUB_ENV
|
|
echo "FC=gfortran-12" >> $GITHUB_ENV
|
|
|
|
# Get files created by release script
|
|
- name: Get tgz-tarball (Linux)
|
|
uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0
|
|
with:
|
|
name: tgz-tarball
|
|
path: ${{ github.workspace }}
|
|
|
|
- name: List files for the space (Linux)
|
|
run: |
|
|
ls -l ${{ github.workspace }}
|
|
ls ${{ runner.workspace }}
|
|
|
|
- name: Uncompress source (Linux)
|
|
run: tar -zxvf ${{ github.workspace }}/${{ steps.set-file-base.outputs.FILE_BASE }}.tar.gz
|
|
|
|
- name: List files for the space (Linux)
|
|
run: |
|
|
ls -l ${{ github.workspace }}
|
|
ls ${{ runner.workspace }}
|
|
|
|
- name: Configure
|
|
shell: bash
|
|
run: |
|
|
mkdir "${{ runner.workspace }}/build"
|
|
cd "${{ runner.workspace }}/build"
|
|
cmake -C ${{ github.workspace }}/hdfsrc/config/cmake/cacheinit.cmake \
|
|
-G Ninja \
|
|
-DCMAKE_BUILD_TYPE=Developer \
|
|
-DBUILD_SHARED_LIBS=ON \
|
|
-DHDF5_ENABLE_ALL_WARNINGS=ON \
|
|
-DHDF5_ENABLE_DEBUG_H5B2=ON \
|
|
-DHDF5_ENABLE_DEBUG_H5FS_ASSERT=ON \
|
|
-DHDF5_ENABLE_PARALLEL:BOOL=OFF \
|
|
-DHDF5_BUILD_CPP_LIB:BOOL=OFF \
|
|
-DHDF5_BUILD_FORTRAN=OFF \
|
|
-DHDF5_BUILD_JAVA=OFF \
|
|
-DHDF5_BUILD_DOC=OFF \
|
|
-DLIBAEC_USE_LOCALCONTENT=OFF \
|
|
-DZLIB_USE_LOCALCONTENT=OFF \
|
|
-DHDF_TEST_EXPRESS=0 \
|
|
${{ github.workspace }}/hdfsrc
|
|
|
|
- name: Build
|
|
run: cmake --build . --parallel 3 --config Developer
|
|
working-directory: ${{ runner.workspace }}/build
|
|
|
|
- name: Run Tests
|
|
env:
|
|
HDF5TestExpress: 0
|
|
run: ctest . --parallel 2 -C Developer -R H5TESTXPR -E fheap
|
|
working-directory: ${{ runner.workspace }}/build
|
|
|
|
win_build_and_test:
|
|
name: "Windows Developer Mode Express Test Workflows"
|
|
|
|
# Don't run the action if the commit message says to skip CI
|
|
if: "!contains(github.event.head_commit.message, 'skip-ci')"
|
|
|
|
runs-on: windows-latest
|
|
steps:
|
|
- name: Get Actions
|
|
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
|
|
with:
|
|
sparse-checkout: .github/actions
|
|
|
|
- name: Setup Doxygen
|
|
uses: ./.github/actions/setup-doxygen
|
|
|
|
- name: Install Dependencies (Windows)
|
|
run: choco install ninja
|
|
|
|
- name: Enable Developer Command Prompt
|
|
uses: ilammy/msvc-dev-cmd@0b201ec74fa43914dc39ae48a89fd1d8cb592756 # v1.13.0
|
|
|
|
- name: Check CMake Version
|
|
shell: bash
|
|
run: |
|
|
which cmake
|
|
cmake --version
|
|
|
|
- name: Set file base name (Windows)
|
|
id: set-file-base
|
|
run: |
|
|
FILE_NAME_BASE=$(echo "${{ inputs.file_base }}")
|
|
echo "FILE_BASE=$FILE_NAME_BASE" >> $GITHUB_OUTPUT
|
|
if [[ '${{ inputs.use_environ }}' == 'release' ]]
|
|
then
|
|
SOURCE_NAME_BASE=$(echo "${{ inputs.snap_name }}")
|
|
else
|
|
SOURCE_NAME_BASE=$(echo "hdfsrc")
|
|
fi
|
|
echo "SOURCE_BASE=$SOURCE_NAME_BASE" >> $GITHUB_OUTPUT
|
|
shell: bash
|
|
|
|
# Get files created by release script
|
|
- name: Get zip-tarball (Windows)
|
|
uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0
|
|
with:
|
|
name: zip-tarball
|
|
path: ${{ github.workspace }}
|
|
|
|
- name: using powershell
|
|
shell: pwsh
|
|
run: Get-Location
|
|
|
|
- name: List files for the space (Windows)
|
|
run: |
|
|
Get-ChildItem -Path ${{ github.workspace }}
|
|
Get-ChildItem -Path ${{ runner.workspace }}
|
|
shell: pwsh
|
|
|
|
- name: Uncompress source (Windows)
|
|
working-directory: ${{ github.workspace }}
|
|
run: 7z x ${{ steps.set-file-base.outputs.FILE_BASE }}.zip
|
|
shell: bash
|
|
|
|
- name: Configure (Windows)
|
|
shell: pwsh
|
|
run: |
|
|
mkdir "${{ runner.workspace }}/build"
|
|
Set-Location -Path "${{ runner.workspace }}\\build"
|
|
cmake -C ${{ github.workspace }}/hdfsrc/config/cmake/cacheinit.cmake -G Ninja -DCMAKE_BUILD_TYPE=Developer -DBUILD_SHARED_LIBS=ON -DHDF5_ENABLE_ALL_WARNINGS=ON -DHDF5_ENABLE_DEBUG_H5B2=ON -DHDF5_ENABLE_DEBUG_H5FS_ASSERT=ON -DHDF5_ENABLE_PARALLEL:BOOL=OFF -DHDF5_BUILD_CPP_LIB=OFF -DHDF5_BUILD_FORTRAN=OFF -DHDF5_BUILD_JAVA=OFF -DHDF5_BUILD_DOC=OFF -DLIBAEC_USE_LOCALCONTENT=OFF -DZLIB_USE_LOCALCONTENT=OFF -DHDF_TEST_EXPRESS=0 ${{ github.workspace }}/hdfsrc
|
|
|
|
- name: Build
|
|
run: cmake --build . --parallel 3 --config Developer
|
|
working-directory: ${{ runner.workspace }}/build
|
|
|
|
- name: Run Tests
|
|
env:
|
|
HDF5TestExpress: 0
|
|
run: ctest . --parallel 2 -C Developer -R H5TESTXPR -E fheap
|
|
working-directory: ${{ runner.workspace }}/build
|
|
|
|
build_and_test_mac_latest:
|
|
# MacOS w/ Clang
|
|
#
|
|
name: "MacOS Clang"
|
|
runs-on: macos-latest
|
|
steps:
|
|
- name: Get Actions
|
|
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
|
|
with:
|
|
sparse-checkout: .github/actions
|
|
|
|
- name: Setup Doxygen
|
|
uses: ./.github/actions/setup-doxygen
|
|
|
|
- name: Install Dependencies (MacOS_latest)
|
|
run: brew install ninja
|
|
|
|
- name: Check Clang Version
|
|
shell: bash
|
|
run: |
|
|
which clang
|
|
clang -v
|
|
|
|
- name: Check CMake Version
|
|
shell: bash
|
|
run: |
|
|
which cmake
|
|
cmake --version
|
|
|
|
- name: Set file base name (MacOS_latest)
|
|
id: set-file-base
|
|
run: |
|
|
FILE_NAME_BASE=$(echo "${{ inputs.file_base }}")
|
|
echo "FILE_BASE=$FILE_NAME_BASE" >> $GITHUB_OUTPUT
|
|
if [[ '${{ inputs.use_environ }}' == 'release' ]]
|
|
then
|
|
SOURCE_NAME_BASE=$(echo "${{ inputs.snap_name }}")
|
|
else
|
|
SOURCE_NAME_BASE=$(echo "hdfsrc")
|
|
fi
|
|
echo "SOURCE_BASE=$SOURCE_NAME_BASE" >> $GITHUB_OUTPUT
|
|
|
|
# Get files created by release script
|
|
- name: Get tgz-tarball (MacOS_latest)
|
|
uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0
|
|
with:
|
|
name: tgz-tarball
|
|
path: ${{ github.workspace }}
|
|
|
|
- name: List files for the space (MacOS_latest)
|
|
run: |
|
|
ls ${{ github.workspace }}
|
|
ls ${{ runner.workspace }}
|
|
|
|
- name: Uncompress source (MacOS_latest)
|
|
run: tar -zxvf ${{ github.workspace }}/${{ steps.set-file-base.outputs.FILE_BASE }}.tar.gz
|
|
|
|
- name: Configure
|
|
shell: bash
|
|
run: |
|
|
mkdir "${{ runner.workspace }}/build"
|
|
cd "${{ runner.workspace }}/build"
|
|
cmake -C ${{ github.workspace }}/hdfsrc/config/cmake/cacheinit.cmake \
|
|
-G Ninja \
|
|
-DCMAKE_BUILD_TYPE=Developer \
|
|
-DBUILD_SHARED_LIBS=ON \
|
|
-DHDF5_ENABLE_ALL_WARNINGS=ON \
|
|
-DHDF5_ENABLE_DEBUG_H5B2=ON \
|
|
-DHDF5_ENABLE_DEBUG_H5FS_ASSERT=ON \
|
|
-DHDF5_ENABLE_PARALLEL:BOOL=OFF \
|
|
-DHDF5_BUILD_CPP_LIB:BOOL=OFF \
|
|
-DHDF5_BUILD_FORTRAN=OFF \
|
|
-DHDF5_BUILD_JAVA=OFF \
|
|
-DHDF5_BUILD_DOC=OFF \
|
|
-DLIBAEC_USE_LOCALCONTENT=OFF \
|
|
-DZLIB_USE_LOCALCONTENT=OFF \
|
|
-DHDF_TEST_EXPRESS=0 \
|
|
${{ github.workspace }}/hdfsrc
|
|
|
|
- name: Build
|
|
run: cmake --build . --parallel 3 --config Developer
|
|
working-directory: ${{ runner.workspace }}/build
|
|
|
|
- name: Run Tests
|
|
env:
|
|
HDF5TestExpress: 0
|
|
run: ctest . --parallel 2 -C Developer -R H5TESTXPR -E fheap
|
|
working-directory: ${{ runner.workspace }}/build
|
|
|
|
####### clang builds
|
|
build_and_test_linux_clang:
|
|
# Linux (Ubuntu) w/ clang
|
|
#
|
|
name: "Ubuntu Clang"
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Get Actions
|
|
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
|
|
with:
|
|
sparse-checkout: .github/actions
|
|
|
|
- name: Setup Doxygen
|
|
uses: ./.github/actions/setup-doxygen
|
|
|
|
- name: Install Dependencies (Linux_clang)
|
|
run: |
|
|
sudo apt-get update
|
|
sudo apt-get install ninja-build graphviz curl
|
|
|
|
- name: Check Clang Version
|
|
shell: bash
|
|
run: |
|
|
which clang
|
|
clang -v
|
|
|
|
- name: Check CMake Version
|
|
shell: bash
|
|
run: |
|
|
which cmake
|
|
cmake --version
|
|
|
|
- name: Set file base name (Linux_clang)
|
|
id: set-file-base
|
|
run: |
|
|
FILE_NAME_BASE=$(echo "${{ inputs.file_base }}")
|
|
echo "FILE_BASE=$FILE_NAME_BASE" >> $GITHUB_OUTPUT
|
|
if [[ '${{ inputs.use_environ }}' == 'release' ]]
|
|
then
|
|
SOURCE_NAME_BASE=$(echo "${{ inputs.snap_name }}")
|
|
else
|
|
SOURCE_NAME_BASE=$(echo "hdfsrc")
|
|
fi
|
|
echo "SOURCE_BASE=$SOURCE_NAME_BASE" >> $GITHUB_OUTPUT
|
|
|
|
# Get files created by release script
|
|
- name: Get tgz-tarball (Linux_clang)
|
|
uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0
|
|
with:
|
|
name: tgz-tarball
|
|
path: ${{ github.workspace }}
|
|
|
|
- name: List files for the space (Linux_clang)
|
|
run: |
|
|
ls -l ${{ github.workspace }}
|
|
ls ${{ runner.workspace }}
|
|
|
|
- name: Uncompress source (Linux_clang)
|
|
run: tar -zxvf ${{ github.workspace }}/${{ steps.set-file-base.outputs.FILE_BASE }}.tar.gz
|
|
|
|
- name: Configure
|
|
shell: bash
|
|
run: |
|
|
mkdir "${{ runner.workspace }}/build"
|
|
cd "${{ runner.workspace }}/build"
|
|
cmake -C ${{ github.workspace }}/hdfsrc/config/cmake/cacheinit.cmake \
|
|
-G Ninja \
|
|
-DCMAKE_BUILD_TYPE=Developer \
|
|
-DBUILD_SHARED_LIBS=ON \
|
|
-DHDF5_ENABLE_ALL_WARNINGS=ON \
|
|
-DHDF5_ENABLE_DEBUG_H5B2=ON \
|
|
-DHDF5_ENABLE_DEBUG_H5FS_ASSERT=ON \
|
|
-DHDF5_ENABLE_PARALLEL:BOOL=OFF \
|
|
-DHDF5_BUILD_CPP_LIB:BOOL=OFF \
|
|
-DHDF5_BUILD_FORTRAN=OFF \
|
|
-DHDF5_BUILD_JAVA=OFF \
|
|
-DHDF5_BUILD_DOC=OFF \
|
|
-DLIBAEC_USE_LOCALCONTENT=OFF \
|
|
-DZLIB_USE_LOCALCONTENT=OFF \
|
|
-DCMAKE_C_COMPILER:STRING=clang \
|
|
-DCMAKE_CXX_COMPILER:STRING=clang++ \
|
|
-DHDF_TEST_EXPRESS=0 \
|
|
${{ github.workspace }}/hdfsrc
|
|
|
|
- name: Build
|
|
run: cmake --build . --parallel 3 --config Developer
|
|
working-directory: ${{ runner.workspace }}/build
|
|
|
|
- name: Run Tests
|
|
env:
|
|
HDF5TestExpress: 0
|
|
run: ctest . --parallel 2 -C Developer -R H5TESTXPR -E fheap
|
|
working-directory: ${{ runner.workspace }}/build
|
|
|