Merge branch 'AcademySoftwareFoundation:main' into main

Author: ssh4net

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,12 +1,15 @@
 ---
 name: Bug report
 about: I think I have identified a legit bug and can describe it.
-title: "[BUG]"
+title: "bug:"
 labels: ''
 assignees: ''
 
 ---
 
+<!-- THESE ARE JUST SUGGESTIONS. FEEL FREE TO DELETE ALL OF THIS AND -->
+<!-- WRITE YOUR OWN THOROUGH BUG REPORT.                             -->
+
 **Describe the bug**
 
 A clear and concise description of what the bug is. What happened, and

.github/ISSUE_TEMPLATE/build_problem.md

@@ -1,16 +1,17 @@
 ---
 name: Build problems
 about: I'm having trouble building OIIO. Help!
-title: "[BUILD]"
+title: "build:"
 labels: ''
 assignees: ''
 
 ---
 
-**PLEASE DO NOT REPORT BUILD TROUBLES AS GITHUB "ISSUES" UNLESS YOU ARE RALLY SURE IT'S A BUG**
+**PLEASE DO NOT REPORT BUILD TROUBLES AS GITHUB "ISSUES" UNLESS YOU ARE REALLY SURE IT'S A BUG**
 
 The best way to get help with your build problems is to ask a question on the
-[oiio-dev developer mail list](https://lists.aswf.io/g/oiio-dev).
+[oiio-dev developer mail list](https://lists.aswf.io/g/oiio-dev) or on the
+[ASWF Slack](https://slack.aswf.io) `#openimageio` channel.
 
 When you email about this, please attach one or both of the following:
 1. The full verbose build log, which you can create like this:

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,12 +1,15 @@
 ---
 name: Feature request
 about: I have a concrete idea about how to improve OpenImageIO.
-title: "[FEATURE REQUEST]"
+title: "feat:"
 labels: ''
 assignees: ''
 
 ---
 
+<!-- THESE ARE JUST SUGGESTIONS. FEEL FREE TO DELETE ALL OF THIS AND -->
+<!-- WRITE YOUR OWN THOROUGH FEATURE REQUEST.                        -->
+
 **Is your feature request related to a problem? Please describe.**
 A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
 

.github/ISSUE_TEMPLATE/question.md

@@ -1,7 +1,7 @@
 ---
 name: Question
 about: How do I...  I need help with...
-title: "[HELP]"
+title: "help:"
 labels: ''
 assignees: ''
 
@@ -18,8 +18,8 @@ But if you are just asking a question:
 * Am I doing something wrong?
 * I can't build OpenImageIO
 
-For anything of this nature, the best way to get help using OpenImageIO is
-to ask a question on the [oiio-dev developer mail list](https://lists.aswf.io/g/oiio-dev).
+For anything of this nature, the best way to get help using OpenImageIO is to
+ask a question on the [oiio-dev developer mail list](https://lists.aswf.io/g/oiio-dev) or the [ASWF Slack](https://slack.aswf.io) `#openimageio` channel.
 
 The [documentation](https://docs.openimageio.org)
 is pretty comprehensive, so please check there first; you may find the answer

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,34 +1,47 @@
-<!-- This is just a guideline and set of reminders about what constitutes -->
-<!-- a good PR. Feel free to delete all this matter and replace it with   -->
-<!-- your own detailed message about the PR, assuming you hit all the     -->
-<!-- important points made below.                                         -->
 
 
-## Description
+
+------ :scissors: -------------------------------------------------------------------
+
+YOU MAY DELETE ALL OF THIS IF YOU ALREADY HAVE A DESCRIPTIVE COMMIT MESSAGE!
+
+This is just a template and set of reminders about what constitutes a good PR.
+But please look over the checklist at the bottom.
+
+If THIS TEXT is still in your PR description, we'll know you didn't read the
+instructions!
+
+
+
+
+### Description
 
 <!-- Please provide a description of what this PR is meant to fix, and  -->
 <!-- how it works (if it's not going to be very clear from the code).   -->
 
-## Tests
+### Tests
 
 <!-- Did you / should you add a testsuite case (new test, or add to an  -->
 <!-- existing test) to verify that this works?                          -->
 
 
-## Checklist:
+### Checklist:
 
 <!-- Put an 'x' in the boxes as you complete the checklist items -->
 
-- [ ] I have read the [contribution guidelines](https://github.com/AcademySoftwareFoundation/OpenImageIO/blob/main/CONTRIBUTING.md).
-- [ ] I have updated the documentation, if applicable. (Check if there is no
-  need to update the documentation, for example if this is a bug fix that
-  doesn't change the API.)
-- [ ] I have ensured that the change is tested somewhere in the testsuite
-  (adding new test cases if necessary).
-- [ ] If I added or modified a C++ API call, I have also amended the
-  corresponding Python bindings (and if altering ImageBufAlgo functions, also
-  exposed the new functionality as oiiotool options).
-- [ ] My code follows the prevailing code style of this project. If I haven't
-  already run clang-format before submitting, I definitely will look at the CI
-  test that runs clang-format and fix anything that it highlights as being
-  nonconforming.
+- [ ] **I have read the guidelines** on [contributions](https://github.com/AcademySoftwareFoundation/OpenImageIO/blob/main/CONTRIBUTING.md) and [code review procedures](https://github.com/AcademySoftwareFoundation/OpenImageIO/blob/main/docs/dev/CodeReview.md).
+- [ ] **I have updated the documentation** if my PR adds features or changes
+  behavior.
+- [ ] **I am sure that this PR's changes are tested somewhere in the
+  testsuite**.
+- [ ] **I have run and passed the testsuite in CI** *before* submitting the
+  PR, by pushing the changes to my fork and seeing that the automated CI
+  passed there. (Exceptions: If most tests pass and you can't figure out why
+  the remaining ones fail, it's ok to submit the PR and ask for help. Or if
+  any failures seem entirely unrelated to your change; sometimes things break
+  on the GitHub runners.)
+- [ ] **My code follows the prevailing code style of this project** and I
+  fixed any problems reported by the clang-format CI test.
+- [ ] If I added or modified a public C++ API call, I have also amended the
+  corresponding Python bindings. If altering ImageBufAlgo functions, I also
+  exposed the new functionality as oiiotool options.

.github/workflows/analysis.yml

@@ -26,6 +26,7 @@ on:
       - '!**/scorecard.yml'
       - '!**/wheel.yml'
       - '!**.properties'
+      - '!pyproject.toml'
       - '!docs/**'
   # Run analysis on PRs only if the branch name indicates that the purpose of
   # the PR is related to the Sonar analysis. We don't run on every PR because
@@ -51,7 +52,7 @@ jobs:
     name: "SonarCloud Analysis"
     # Exclude runs on forks, since only the main org has the SonarCloud
     # account credentials.
-    if: github.repository == 'AcademySoftwareFoundation/OpenImageIO'
+    if: github.event.repository.fork == false
     uses: ./.github/workflows/build-steps.yml
     # Must let the called steps workflow inherit necessary secrets
     secrets:
@@ -87,13 +88,14 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - desc: sonar gcc11/C++17 py310 exr3.2 ocio2.3
+          - desc: sonar gcc11/C++17 py311 exr3.2 ocio2.3
             nametag: static-analysis-sonar
             os: ubuntu-latest
-            container: aswf/ci-osl:2024-clang17
+            container: aswf/ci-oiio:2024.2
             cxx_std: 17
             python_ver: "3.11"
             simd: "avx2,f16c"
+            opencolorio_ver: v2.3.2
             fmt_ver: 10.1.1
             pybind11_ver: v2.12.0
             coverage: 1

.github/workflows/build-steps.yml

@@ -18,6 +18,9 @@ on:
         type: string
       container:
         type: string
+      container_volumes:
+        type: string
+        default: '[]'
       cc_compiler:
         type: string
       cxx_compiler:
@@ -66,8 +69,15 @@ on:
         type: string
       sonar:
         type: string
+      old_node:
+        type: string
+        default: 0
       nametag:
         type: string
+      required_deps:
+        type: string
+      optional_deps:
+        type: string
     secrets:
         PASSED_GITHUB_TOKEN:
           required: false
@@ -84,7 +94,11 @@ jobs:
     runs-on: ${{ inputs.runner }}
     container:
       image: ${{ inputs.container }}
-
+      volumes: ${{ fromJson( inputs.container_volumes ) }}
+      options: -v /:/host/root ${{ (contains(inputs.runner, 'gpu') && '-e NVIDIA_DRIVER_CAPABILITIES=compute,graphics,utility --gpus all') || '-e A=x' }}
+      # Extra options:
+      # - Ensure the GPU runners have OptiX is visible in the container.
+      # - Mount the native filesystem under /host/root
     env:
       CXX: ${{inputs.cxx_compiler}}
       CC: ${{inputs.cc_compiler}}
@@ -94,16 +108,26 @@ jobs:
       CTEST_ARGS: ${{inputs.ctest_args}}
       CTEST_TEST_TIMEOUT: ${{inputs.ctest_test_timeout}}
       USE_SIMD: ${{inputs.simd}}
-      FMT_VERSION: ${{inputs.fmt_ver}}
+      fmt_BUILD_VERSION: ${{inputs.fmt_ver}}
       OPENCOLORIO_VERSION: ${{inputs.opencolorio_ver}}
       OPENEXR_VERSION: ${{inputs.openexr_ver}}
       PYBIND11_VERSION: ${{inputs.pybind11_ver}}
       PYTHON_VERSION: ${{inputs.python_ver}}
       ABI_CHECK: ${{inputs.abi_check}}
       ACTIONS_RUNNER_FORCE_ACTIONS_NODE_VERSION: node16
       ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION: true
+      # For CI, sometimes we want to require all dependencies to be present,
+      # except for a select few listed explicitly. This ensures that we don't
+      # accidentally have a situation in which we think we are building
+      # against and testing an optional dependency, but in fact are not.
+      OpenImageIO_REQUIRED_DEPS: ${{inputs.required_deps}}
+      OpenImageIO_OPTIONAL_DEPS: ${{inputs.optional_deps}}
 
     steps:
+      - name: install nodejs20glibc2.17
+        if: inputs.old_node == '1'
+        run: |
+          curl --silent https://unofficial-builds.nodejs.org/download/release/v20.18.1/node-v20.18.1-linux-x64-glibc-217.tar.xz | tar -xJ --strip-components 1 -C /node20217 -f -
       - name: Checkout repo
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Build setup
@@ -117,7 +141,7 @@ jobs:
         run: echo "date=`date -u +'%Y-%m-%dT%H:%M:%SZ'`" >> $GITHUB_OUTPUT
       - name: ccache-restore
         id: ccache-restore
-        uses: actions/cache/restore@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3
+        uses: actions/cache/restore@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
         with:
           path: ${{ env.CCACHE_DIR }}
           # path: ./ccache
@@ -136,7 +160,7 @@ jobs:
             fi
       - name:  Install sonar-scanner and build-wrapper
         if: inputs.sonar == '1'
-        uses: sonarsource/sonarcloud-github-c-cpp@e4882e1621ad2fb48dddfa48287411bed34789b1 # v2.0.2
+        uses: sonarsource/sonarqube-scan-action@fd88b7d7ccbaefd23d8f36f73b59db7a3d246602 # v6.0.0
       - name: Build
         if: inputs.skip_build != '1'
         shell: bash
@@ -157,7 +181,7 @@ jobs:
             popd
       - name: ccache-save
         id: ccache-save
-        uses: actions/cache/save@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3
+        uses: actions/cache/save@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
         with:
           path: ${{ env.CCACHE_DIR }}
           key: ${{inputs.nametag}}-${{steps.ccache_cache_keys.outputs.date}}
@@ -177,7 +201,7 @@ jobs:
         if: inputs.coverage == '1'
         run: src/build-scripts/ci-coverage.bash
       - name: Sonar-scanner
-        if: inputs.sonar == 1
+        if: inputs.sonar == '1'
         env:
           GITHUB_TOKEN: ${{ secrets.PASSED_GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.PASSED_SONAR_TOKEN }}
@@ -186,8 +210,8 @@ jobs:
             ls -l /__w/OpenImageIO/OpenImageIO/bw_output
             echo "BUILD_OUTPUT_DIR is " "${{ env.BUILD_WRAPPER_OUT_DIR }}"
             find . -name "*.gcov" -print
-            # sonar-scanner --define sonar.cfamily.build-wrapper-output="${{ env.BUILD_WRAPPER_OUT_DIR }}"
-            time sonar-scanner --define sonar.host.url="${{ env.SONAR_SERVER_URL }}" --define sonar.cfamily.build-wrapper-output="$BUILD_WRAPPER_OUT_DIR" --define sonar.cfamily.gcov.reportsPath="_coverage" --define sonar.cfamily.threads="$PARALLEL"
+            # sonar-scanner --define sonar.cfamily.compile-commands="${{ env.BUILD_WRAPPER_OUT_DIR }}/compile_commands.json"
+            time sonar-scanner --define sonar.host.url="${{ env.SONAR_SERVER_URL }}" --define sonar.cfamily.compile-commands="$BUILD_WRAPPER_OUT_DIR/compile_commands.json" --define sonar.cfamily.gcov.reportsPath="_coverage" --define sonar.cfamily.threads="$PARALLEL"
         # Consult https://docs.sonarcloud.io/advanced-setup/ci-based-analysis/sonarscanner-cli/ for more information and options
       - name: Check ABI
         if: inputs.abi_check != ''
@@ -203,7 +227,7 @@ jobs:
             time make sphinx
       - name: Upload testsuite debugging artifacts
         uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0
-        if: ${{ failure() || inputs.build_docs == '1' || inputs.benchmark == '1' }}
+        if: ${{ failure() || inputs.build_docs == '1' || inputs.benchmark == '1' || inputs.abi_check != '' }}
         with:
           name: oiio-${{github.job}}-${{inputs.nametag}}
           path: |