Skip to content

Commit

Permalink
Try docs
Browse files Browse the repository at this point in the history 
Signed-off-by: Larry Gritz <[email protected]>
  • Loading branch information
@lgritz
lgritz committed Nov 28, 2024
1 parent d1ec0c9 commit 5bcd6bb
Showing 1 changed file with 117 additions and 93 deletions.
210 changes: 117 additions & 93 deletions .github/workflows/docs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,32 @@ permissions: read-all

jobs:

aswf:
name: "Docs / VFX${{matrix.vfxyear}} ${{matrix.desc}}"
docs:
name: "Docs / ${{matrix.desc}}"
uses: ./.github/workflows/ci-steps.yml
with:
runner: ${{ matrix.runner || 'ubuntu-latest' }}
container: ${{ matrix.container }}
cc_compiler: ${{ matrix.cc_compiler }}
cxx_compiler: ${{ matrix.cxx_compiler }}
cxx_std: ${{ matrix.cxx_std || '17' }}
depcmds: ${{ matrix.depcmds }}
extra_artifacts: ${{ matrix.extra_artifacts }}
fmt_ver: ${{ matrix.fmt_ver }}
opencolorio_ver: ${{ matrix.opencolorio_ver }}
openexr_ver: ${{ matrix.openexr_ver }}
pybind11_ver: ${{ matrix.pybind11_ver }}
python_ver: ${{ matrix.python_ver }}
setenvs: ${{ matrix.setenvs }}
simd: ${{ matrix.simd }}
skip_tests: ${{ matrix.skip_tests }}
abi_check: ${{ matrix.abi_check }}
build_docs: ${{ matrix.build_docs }}
generator: ${{ matrix.generator }}
ctest_args: ${{ matrix.ctest_args }}
ctest_test_timeout: ${{ matrix.ctest_test_timeout }}
nametag: ${{ matrix.nametag || 'unnamed!' }}

strategy:
fail-fast: false
matrix:
Expand All @@ -56,96 +80,96 @@ jobs:
setenvs: export EXTRA_DEP_PACKAGES="doxygen sphinx-doc"
PIP_INSTALLS="sphinx breathe sphinx-tabs furo"

runs-on: ${{ matrix.runner }}
container:
image: ${{ matrix.container }}
env:
CXX: ${{matrix.cxx_compiler}}
CC: ${{matrix.cc_compiler}}
CMAKE_CXX_STANDARD: ${{matrix.cxx_std}}
USE_SIMD: ${{matrix.simd}}
FMT_VERSION: ${{matrix.fmt_ver}}
OPENCOLORIO_VERSION: ${{matrix.opencolorio_ver}}
OPENEXR_VERSION: ${{matrix.openexr_ver}}
PYBIND11_VERSION: ${{matrix.pybind11_ver}}
PYTHON_VERSION: ${{matrix.python_ver}}
ABI_CHECK: ${{matrix.abi_check}}
ACTIONS_RUNNER_FORCE_ACTIONS_NODE_VERSION: node16
ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION: true
steps:
# We would like to use harden-runner, but it flags too many false
# positives, every time we download a dependency. We should use it only
# on CI runs where we are producing artifacts that users might rely on.
# - name: Harden Runner
# uses: step-security/harden-runner@248ae51c2e8cc9622ecf50685c8bf7150c6e8813 # v1.4.3
# with:
# egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs
- uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
# Note: can't upgrade to actions/checkout 4.0 because it needs newer
# glibc than these containers have.
- name: Prepare ccache timestamp
id: ccache_cache_keys
run: echo "date=`date -u +'%Y-%m-%dT%H:%M:%SZ'`" >> $GITHUB_OUTPUT
- name: ccache
id: ccache
uses: actions/cache@e12d46a63a90f2fae62d114769bbf2a179198b5c # v3.3.3
# Note: can't upgrade to actions/cache 4.0 because it needs newer
# glibc than these containers have.
with:
path: /tmp/ccache
key: ${{github.job}}-${{matrix.nametag}}-${{steps.ccache_cache_keys.outputs.date}}
restore-keys: ${{github.job}}-
- name: Build setup
run: |
${{matrix.setenvs}}
src/build-scripts/ci-startup.bash
- name: Dependencies
run: |
${{matrix.depcmds}}
src/build-scripts/gh-installdeps.bash
- name: Build
if: matrix.skip_build != '1'
run: src/build-scripts/ci-build.bash
- name: Testsuite
if: matrix.skip_tests != '1'
run: src/build-scripts/ci-test.bash
- name: Check out ABI standard
if: matrix.abi_check != ''
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
ref: ${{matrix.abi_check}}
path: abi_standard
- name: Build ABI standard
if: matrix.abi_check != ''
run: |
mkdir -p abi_standard/build
pushd abi_standard
src/build-scripts/ci-build.bash
popd
- name: Check ABI
if: matrix.abi_check != ''
run: |
src/build-scripts/ci-abicheck.bash ./build abi_standard/build libOpenImageIO libOpenImageIO_Util
- name: Build Docs
if: matrix.build_docs == '1'
run: |
cd src/doc
time make doxygen
time make sphinx
- uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3
# Note: versions of upload-artifact >= 4.0 can't run on the ASWF
# containers because they need a newer glibc than they have.
if: ${{ failure() || matrix.build_docs == '1'}}
with:
name: oiio-${{github.job}}-${{matrix.nametag}}
path: |
build/cmake-save
build/compat_reports
build/sphinx
build/testsuite/*/*.*
!build/testsuite/oiio-images
!build/testsuite/openexr-images
!build/testsuite/fits-images
!build/testsuite/j2kp4files_v1_5
# runs-on: ${{ matrix.runner }}
# container:
# image: ${{ matrix.container }}
# env:
# CXX: ${{matrix.cxx_compiler}}
# CC: ${{matrix.cc_compiler}}
# CMAKE_CXX_STANDARD: ${{matrix.cxx_std}}
# USE_SIMD: ${{matrix.simd}}
# FMT_VERSION: ${{matrix.fmt_ver}}
# OPENCOLORIO_VERSION: ${{matrix.opencolorio_ver}}
# OPENEXR_VERSION: ${{matrix.openexr_ver}}
# PYBIND11_VERSION: ${{matrix.pybind11_ver}}
# PYTHON_VERSION: ${{matrix.python_ver}}
# ABI_CHECK: ${{matrix.abi_check}}
# ACTIONS_RUNNER_FORCE_ACTIONS_NODE_VERSION: node16
# ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION: true
# steps:
# # We would like to use harden-runner, but it flags too many false
# # positives, every time we download a dependency. We should use it only
# # on CI runs where we are producing artifacts that users might rely on.
# # - name: Harden Runner
# # uses: step-security/harden-runner@248ae51c2e8cc9622ecf50685c8bf7150c6e8813 # v1.4.3
# # with:
# # egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs
# - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
# # Note: can't upgrade to actions/checkout 4.0 because it needs newer
# # glibc than these containers have.
# - name: Prepare ccache timestamp
# id: ccache_cache_keys
# run: echo "date=`date -u +'%Y-%m-%dT%H:%M:%SZ'`" >> $GITHUB_OUTPUT
# - name: ccache
# id: ccache
# uses: actions/cache@e12d46a63a90f2fae62d114769bbf2a179198b5c # v3.3.3
# # Note: can't upgrade to actions/cache 4.0 because it needs newer
# # glibc than these containers have.
# with:
# path: /tmp/ccache
# key: ${{github.job}}-${{matrix.nametag}}-${{steps.ccache_cache_keys.outputs.date}}
# restore-keys: ${{github.job}}-
# - name: Build setup
# run: |
# ${{matrix.setenvs}}
# src/build-scripts/ci-startup.bash
# - name: Dependencies
# run: |
# ${{matrix.depcmds}}
# src/build-scripts/gh-installdeps.bash
# - name: Build
# if: matrix.skip_build != '1'
# run: src/build-scripts/ci-build.bash
# - name: Testsuite
# if: matrix.skip_tests != '1'
# run: src/build-scripts/ci-test.bash
# - name: Check out ABI standard
# if: matrix.abi_check != ''
# uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
# with:
# ref: ${{matrix.abi_check}}
# path: abi_standard
# - name: Build ABI standard
# if: matrix.abi_check != ''
# run: |
# mkdir -p abi_standard/build
# pushd abi_standard
# src/build-scripts/ci-build.bash
# popd
# - name: Check ABI
# if: matrix.abi_check != ''
# run: |
# src/build-scripts/ci-abicheck.bash ./build abi_standard/build libOpenImageIO libOpenImageIO_Util
# - name: Build Docs
# if: matrix.build_docs == '1'
# run: |
# cd src/doc
# time make doxygen
# time make sphinx
# - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3
# # Note: versions of upload-artifact >= 4.0 can't run on the ASWF
# # containers because they need a newer glibc than they have.
# if: ${{ failure() || matrix.build_docs == '1'}}
# with:
# name: oiio-${{github.job}}-${{matrix.nametag}}
# path: |
# build/cmake-save
# build/compat_reports
# build/sphinx
# build/testsuite/*/*.*
# !build/testsuite/oiio-images
# !build/testsuite/openexr-images
# !build/testsuite/fits-images
# !build/testsuite/j2kp4files_v1_5


0 comments on commit 5bcd6bb

Please sign in to comment.