summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2023-06-05 23:27:40 (GMT)
committerGitHub <noreply@github.com>2023-06-05 23:27:40 (GMT)
commit2384a731763a7ceb11e39d48cc0f6991d908389e (patch)
tree8821c86d1437fe8200217f3a1cc8fb5a241617f0
parent66cee727684ee3bca63d3ccd57bc4ae7a184bb31 (diff)
downloadhdf5-2384a731763a7ceb11e39d48cc0f6991d908389e.zip
hdf5-2384a731763a7ceb11e39d48cc0f6991d908389e.tar.gz
hdf5-2384a731763a7ceb11e39d48cc0f6991d908389e.tar.bz2
Develop gh doxy (#3041)
* Add doxygen generation to daily-build and main * Add doxygen option to matrix
-rw-r--r--.github/workflows/cmake-ctest.yml12
-rw-r--r--.github/workflows/main.yml23
-rw-r--r--.github/workflows/release.yml7
3 files changed, 36 insertions, 6 deletions
diff --git a/.github/workflows/cmake-ctest.yml b/.github/workflows/cmake-ctest.yml
index 02d8205..551f3f7 100644
--- a/.github/workflows/cmake-ctest.yml
+++ b/.github/workflows/cmake-ctest.yml
@@ -96,7 +96,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Install CMake Dependencies (Linux)
- run: sudo apt-get install ninja-build
+ run: sudo apt-get install ninja-build doxygen graphviz
- name: Set file base name (Linux)
id: set-file-base
@@ -151,6 +151,14 @@ jobs:
path: ${{ runner.workspace }}/build/${{ steps.set-file-base.outputs.FILE_BASE }}-ubuntu-2204.tar.gz
if-no-files-found: error # 'warn' or 'ignore' are also available, defaults to `warn`
+ # Save doxygen files created by ctest script
+ - name: Save published binary (Linux)
+ uses: actions/upload-artifact@v3
+ with:
+ name: docs-doxygen
+ path: ${{ runner.workspace }}/build/hdf5lib_docs/html
+ if-no-files-found: error # 'warn' or 'ignore' are also available, defaults to `warn`
+
build_and_test_mac:
# MacOS w/ Clang + CMake
#
@@ -158,7 +166,7 @@ jobs:
runs-on: macos-11
steps:
- name: Install Dependencies (MacOS)
- run: brew install ninja
+ run: brew install ninja doxygen
- name: Set file base name (MacOS)
id: set-file-base
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 3ca25d3..fd46dc3 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -81,6 +81,7 @@ jobs:
cpp: ON
fortran: OFF
java: ON
+ docs: OFF
libaecfc: ON
localaec: OFF
zlibfc: ON
@@ -100,6 +101,7 @@ jobs:
cpp: ON
fortran: ON
java: ON
+ docs: ON
libaecfc: ON
localaec: OFF
zlibfc: ON
@@ -120,6 +122,7 @@ jobs:
cpp: enable
fortran: enable
java: enable
+ docs: disable
parallel: disable
mirror_vfd: enable
direct_vfd: enable
@@ -141,6 +144,7 @@ jobs:
cpp: disable
fortran: enable
java: disable
+ docs: disable
parallel: enable
mirror_vfd: disable
direct_vfd: disable
@@ -161,6 +165,7 @@ jobs:
cpp: ON
fortran: OFF
java: ON
+ docs: OFF
libaecfc: ON
localaec: OFF
zlibfc: ON
@@ -186,6 +191,7 @@ jobs:
cpp: enable
fortran: enable
java: enable
+ docs: disable
parallel: disable
mirror_vfd: enable
direct_vfd: enable
@@ -209,6 +215,7 @@ jobs:
cpp: enable
fortran: enable
java: enable
+ docs: disable
parallel: disable
mirror_vfd: enable
direct_vfd: enable
@@ -232,6 +239,7 @@ jobs:
cpp: enable
fortran: enable
java: enable
+ docs: disable
parallel: disable
mirror_vfd: enable
direct_vfd: enable
@@ -255,6 +263,7 @@ jobs:
cpp: enable
fortran: enable
java: enable
+ docs: disable
parallel: disable
mirror_vfd: enable
direct_vfd: enable
@@ -278,6 +287,7 @@ jobs:
cpp: enable
fortran: enable
java: enable
+ docs: disable
parallel: disable
mirror_vfd: enable
direct_vfd: enable
@@ -301,6 +311,7 @@ jobs:
cpp: enable
fortran: enable
java: enable
+ docs: disable
parallel: disable
mirror_vfd: enable
direct_vfd: enable
@@ -325,6 +336,7 @@ jobs:
cpp: enable
fortran: disable
java: enable
+ docs: disable
parallel: disable
mirror_vfd: disable
direct_vfd: enable
@@ -349,6 +361,7 @@ jobs:
cpp: enable
fortran: disable
java: enable
+ docs: disable
parallel: disable
mirror_vfd: disable
direct_vfd: enable
@@ -373,6 +386,7 @@ jobs:
cpp: disable
fortran: disable
java: disable
+ docs: disable
parallel: enable
mirror_vfd: disable
direct_vfd: enable
@@ -396,6 +410,7 @@ jobs:
cpp: disable
fortran: disable
java: disable
+ docs: disable
parallel: enable
mirror_vfd: disable
direct_vfd: enable
@@ -434,7 +449,7 @@ jobs:
run: echo '${{ toJSON(matrix) }}'
- name: Install CMake Dependencies (Linux)
- run: sudo apt-get install ninja-build
+ run: sudo apt-get install ninja-build doxygen graphviz
if: matrix.os == 'ubuntu-latest'
- name: Install Autotools Dependencies (Linux, serial)
@@ -463,7 +478,7 @@ jobs:
if: matrix.os == 'windows-latest'
- name: Install Dependencies (macOS)
- run: brew install ninja
+ run: brew install ninja doxygen
if: matrix.os == 'macos-13'
- name: Set environment for MSVC (Windows)
@@ -507,7 +522,7 @@ jobs:
run: |
mkdir "${{ runner.workspace }}/build"
cd "${{ runner.workspace }}/build"
- cmake -C $GITHUB_WORKSPACE/config/cmake/cacheinit.cmake ${{ matrix.generator }} -DCMAKE_BUILD_TYPE=${{ matrix.build_mode.cmake }} -DCMAKE_TOOLCHAIN_FILE=${{ matrix.toolchain }} -DBUILD_SHARED_LIBS=ON -DHDF5_ENABLE_ALL_WARNINGS=ON -DHDF5_ENABLE_PARALLEL:BOOL=${{ matrix.parallel }} -DHDF5_BUILD_CPP_LIB:BOOL=${{ matrix.cpp }} -DHDF5_BUILD_FORTRAN=${{ matrix.fortran }} -DHDF5_BUILD_JAVA=${{ matrix.java }} -DBUILD_SZIP_WITH_FETCHCONTENT=${{ matrix.libaecfc }} -DLIBAEC_USE_LOCALCONTENT=${{ matrix.localaec }} -DBUILD_ZLIB_WITH_FETCHCONTENT=${{ matrix.zlibfc }} -DZLIB_USE_LOCALCONTENT=${{ matrix.localzlib }} -DHDF5_ENABLE_MIRROR_VFD:BOOL=${{ matrix.mirror_vfd }} -DHDF5_ENABLE_DIRECT_VFD:BOOL=${{ matrix.direct_vfd }} $GITHUB_WORKSPACE
+ cmake -C $GITHUB_WORKSPACE/config/cmake/cacheinit.cmake ${{ matrix.generator }} -DCMAKE_BUILD_TYPE=${{ matrix.build_mode.cmake }} -DCMAKE_TOOLCHAIN_FILE=${{ matrix.toolchain }} -DBUILD_SHARED_LIBS=ON -DHDF5_ENABLE_ALL_WARNINGS=ON -DHDF5_ENABLE_PARALLEL:BOOL=${{ matrix.parallel }} -DHDF5_BUILD_CPP_LIB:BOOL=${{ matrix.cpp }} -DHDF5_BUILD_FORTRAN=${{ matrix.fortran }} -DHDF5_BUILD_JAVA=${{ matrix.java }} -DHDF5_BUILD_DOC=${{ matrix.docs }} -DBUILD_SZIP_WITH_FETCHCONTENT=${{ matrix.libaecfc }} -DLIBAEC_USE_LOCALCONTENT=${{ matrix.localaec }} -DBUILD_ZLIB_WITH_FETCHCONTENT=${{ matrix.zlibfc }} -DZLIB_USE_LOCALCONTENT=${{ matrix.localzlib }} -DHDF5_ENABLE_MIRROR_VFD:BOOL=${{ matrix.mirror_vfd }} -DHDF5_ENABLE_DIRECT_VFD:BOOL=${{ matrix.direct_vfd }} $GITHUB_WORKSPACE
shell: bash
if: (matrix.generator != 'autogen') && ! (matrix.thread_safety.enabled)
@@ -516,7 +531,7 @@ jobs:
run: |
mkdir "${{ runner.workspace }}/build"
cd "${{ runner.workspace }}/build"
- cmake -C $GITHUB_WORKSPACE/config/cmake/cacheinit.cmake ${{ matrix.generator }} -DCMAKE_BUILD_TYPE=${{ matrix.build_mode.cmake }} -DCMAKE_TOOLCHAIN_FILE=${{ matrix.toolchain }} -DBUILD_SHARED_LIBS=ON -DHDF5_ENABLE_ALL_WARNINGS=ON -DHDF5_ENABLE_THREADSAFE:BOOL=ON -DHDF5_ENABLE_PARALLEL:BOOL=${{ matrix.parallel }} -DHDF5_BUILD_CPP_LIB:BOOL=OFF -DHDF5_BUILD_FORTRAN:BOOL=OFF -DHDF5_BUILD_JAVA:BOOL=OFF -DHDF5_BUILD_HL_LIB:BOOL=OFF -DBUILD_SZIP_WITH_FETCHCONTENT=${{ matrix.libaecfc }} -DLIBAEC_USE_LOCALCONTENT=${{ matrix.localaec }} -DBUILD_ZLIB_WITH_FETCHCONTENT=${{ matrix.zlibfc }} -DZLIB_USE_LOCALCONTENT=${{ matrix.localzlib }} -DHDF5_ENABLE_MIRROR_VFD:BOOL=${{ matrix.mirror_vfd }} -DHDF5_ENABLE_DIRECT_VFD:BOOL=${{ matrix.direct_vfd }} $GITHUB_WORKSPACE
+ cmake -C $GITHUB_WORKSPACE/config/cmake/cacheinit.cmake ${{ matrix.generator }} -DCMAKE_BUILD_TYPE=${{ matrix.build_mode.cmake }} -DCMAKE_TOOLCHAIN_FILE=${{ matrix.toolchain }} -DBUILD_SHARED_LIBS=ON -DHDF5_ENABLE_ALL_WARNINGS=ON -DHDF5_ENABLE_THREADSAFE:BOOL=ON -DHDF5_ENABLE_PARALLEL:BOOL=${{ matrix.parallel }} -DHDF5_BUILD_CPP_LIB:BOOL=OFF -DHDF5_BUILD_FORTRAN:BOOL=OFF -DHDF5_BUILD_JAVA:BOOL=OFF -DHDF5_BUILD_HL_LIB:BOOL=OFF -DHDF5_BUILD_DOC=OFF -DBUILD_SZIP_WITH_FETCHCONTENT=${{ matrix.libaecfc }} -DLIBAEC_USE_LOCALCONTENT=${{ matrix.localaec }} -DBUILD_ZLIB_WITH_FETCHCONTENT=${{ matrix.zlibfc }} -DZLIB_USE_LOCALCONTENT=${{ matrix.localzlib }} -DHDF5_ENABLE_MIRROR_VFD:BOOL=${{ matrix.mirror_vfd }} -DHDF5_ENABLE_DIRECT_VFD:BOOL=${{ matrix.direct_vfd }} $GITHUB_WORKSPACE
shell: bash
if: (matrix.generator != 'autogen') && (matrix.thread_safety.enabled)
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index ed085bf..d08ab2f 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -55,6 +55,12 @@ jobs:
echo "FILE_BASE=$FILE_NAME_BASE" >> $GITHUB_OUTPUT
# Get files created by tarball script
+ - name: Get doxygen (Linux)
+ uses: actions/download-artifact@v3
+ with:
+ name: docs-doxygen
+ path: ${{ github.workspace }}/${{ steps.get-file-base.outputs.FILE_BASE }}.doxygen
+
- name: Get tgz-tarball (Linux)
uses: actions/download-artifact@v3
with:
@@ -107,6 +113,7 @@ jobs:
tag_name: "snapshot"
prerelease: true
files: |
+ ${{ steps.get-file-base.outputs.FILE_BASE }}.doxygen
${{ steps.get-file-base.outputs.FILE_BASE }}.tar.gz
${{ steps.get-file-base.outputs.FILE_BASE }}.zip
${{ steps.get-file-base.outputs.FILE_BASE }}-osx12.tar.gz