Merge release v25.05

Author: pixar-oss

.github/pull_request_template.md

@@ -6,14 +6,14 @@
 
 ### Checklist
 
-[ ] I have created this PR based on the dev branch
+- [ ] I have created this PR based on the dev branch
 
-[ ] I have followed the [coding conventions](https://openusd.org/release/api/_page__coding__guidelines.html)
+- [ ] I have followed the [coding conventions](https://openusd.org/release/api/_page__coding__guidelines.html)
 
-[ ] I have added unit tests that exercise this functionality (Reference: 
-[testing guidelines](https://openusd.org/release/api/_page__testing__guidelines.html))
+- [ ] I have added unit tests that exercise this functionality (Reference: 
+  [testing guidelines](https://openusd.org/release/api/_page__testing__guidelines.html))
 
-[ ] I have verified that all unit tests pass with the proposed changes
+- [ ] I have verified that all unit tests pass with the proposed changes
 
-[ ] I have submitted a signed Contributor License Agreement (Reference: 
-[Contributor License Agreement instructions](https://openusd.org/release/contributing_to_usd.html#contributor-license-agreement))
+- [ ] I have submitted a signed Contributor License Agreement (Reference: 
+  [Contributor License Agreement instructions](https://openusd.org/release/contributing_to_usd.html#contributor-license-agreement))

.github/workflows/buildusd.yml

@@ -5,16 +5,12 @@ on:
     branches:
       - dev
       - release
-  issue_comment:                                     
+  issue_comment:
     types: [created]
 
-env:
-  PYTHON_VERSION: "3.9"
-  PYTHON_VERSION_MAC: "3.11"
-
 jobs:
   GetUser:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     timeout-minutes: 5
     outputs:
       require-result: ${{ steps.check.outputs.require-result }}
@@ -24,8 +20,9 @@ jobs:
         with:
           require: 'write'
           username: ${{ github.event.comment.user.login }}
+
   GetGitRef:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     timeout-minutes: 5
     outputs:
       ref: ${{ steps.setter.outputs.ref }}
@@ -45,13 +42,17 @@ jobs:
         id: setter
         run: |
           echo "ref=$REF" >> "$GITHUB_OUTPUT"
+
   Linux:
-    needs: [GetUser, GetGitRef]
+    needs:
+      - GetUser
+      - GetGitRef
     if: ${{ (github.event.issue.pull_request && contains(github.event.comment.body, '/AzurePipelines run') && needs.GetUser.outputs.require-result == 'true' ) || github.event_name == 'push' }}
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
+    env:
+      PYTHON_VERSION: "3.9"
     timeout-minutes: 120
     steps:
-      - run: echo ${{ needs.GetUser.outputs.require-result }}
       - name: Checkout code
         uses: actions/checkout@v4
         with:
@@ -76,27 +77,35 @@ jobs:
           pip install PySide2 PyOpenGL
       - name: Build USD
         run: |
-          python3 build_scripts/build_usd.py --no-materialx --build USDgen/build --src USDgen/src USDinst -v
+          # Not using '--tests' to avoid building extra dependencies that are unneeded for headless tests
+          python3 build_scripts/build_usd.py --no-materialx --build USDgen/build --src USDgen/src USDinst --build-args USD,"-DPXR_HEADLESS_TEST_MODE=ON -DPXR_BUILD_TESTS=ON" -v
       - name: Save build artifacts to cache
         if: steps.cache-usd-build-dependency.outputs.cache-hit != 'true'
         uses: actions/cache/save@v4
         with:
           path: |
             USDinst
-          key: ${{ runner.os }}-BuildUSD-py${{ env.PYTHON_VERSION }}-${{ hashFiles('build_scripts/**/*') }}
+          key: ${{ steps.cache-usd-build-dependency.outputs.cache-primary-key }}
       - name: Upload artifacts
         uses: actions/upload-artifact@v4
         with:
           name: usd-linux
           path: USDinst
+      - name: Test USD
+        working-directory: ./USDgen/build/OpenUSD
+        run: |
+          ctest -V -C Release
 
   macOS:
-    needs: [GetUser, GetGitRef]
+    needs:
+      - GetUser
+      - GetGitRef
     if: ${{ (github.event.issue.pull_request && contains(github.event.comment.body, '/AzurePipelines run') && needs.GetUser.outputs.require-result == 'true' ) || github.event_name == 'push' }}
     runs-on: macos-13
+    env:
+      PYTHON_VERSION: "3.11"
     timeout-minutes: 120
     steps:
-      - run: echo ${{ needs.GetUser.outputs.require-result }}
       - name: Checkout code
         uses: actions/checkout@v4
         with:
@@ -107,11 +116,11 @@ jobs:
         with:
           path: |
             USDinst
-          key: ${{ runner.os }}-BuildUSD-py${{ env.PYTHON_VERSION_MAC }}-${{ hashFiles('build_scripts/**/*') }}
+          key: ${{ runner.os }}-BuildUSD-py${{ env.PYTHON_VERSION }}-${{ hashFiles('build_scripts/**/*') }}
       - name: Install Python
         uses: actions/setup-python@v5
         with:
-          python-version: ${{ env.PYTHON_VERSION_MAC }}
+          python-version: ${{ env.PYTHON_VERSION }}
           check-latest: false
       - name: Install dependencies
         run: |
@@ -124,28 +133,37 @@ jobs:
           export -n SYSTEM_VERSION_COMPAT
       - name: Build USD
         run: |
+          # Not using '--tests' to avoid building extra dependencies that are unneeded for headless tests
           export PATH=/Applications/CMake.app/Contents/bin:$PATH
-          python3 build_scripts/build_usd.py --no-materialx --generator Xcode --build USDgen/build --src USDgen/src USDinst -v
+          python3 build_scripts/build_usd.py --no-materialx --generator Xcode --build USDgen/build --src USDgen/src USDinst --build-args USD,"-DPXR_HEADLESS_TEST_MODE=ON -DPXR_BUILD_TESTS=ON" -v
       - name: Save build artifacts to cache
         if: steps.cache-usd-build-dependency.outputs.cache-hit != 'true'
         uses: actions/cache/save@v4
         with:
           path: |
             USDinst
-          key: ${{ runner.os }}-BuildUSD-py${{ env.PYTHON_VERSION_MAC }}-${{ hashFiles('build_scripts/**/*') }}
+          key: ${{ steps.cache-usd-build-dependency.outputs.cache-primary-key }}
       - name: Upload artifacts
         uses: actions/upload-artifact@v4
         with:
           name: usd-macOS
           path: USDinst
+      - name: Test USD
+        working-directory: ./USDgen/build/OpenUSD
+        run: |
+          export PATH=/Applications/CMake.app/Contents/bin:$PATH
+          ctest -V -C Release
 
   Windows:
-    needs: [GetUser, GetGitRef]
+    needs:
+      - GetUser
+      - GetGitRef
     if: ${{ (github.event.issue.pull_request && contains(github.event.comment.body, '/AzurePipelines run') && needs.GetUser.outputs.require-result == 'true' ) || github.event_name == 'push' }}
     runs-on: windows-2019
+    env:
+      PYTHON_VERSION: "3.9"
     timeout-minutes: 120
     steps:
-      - run: echo ${{ needs.GetUser.outputs.require-result }}
       - name: Checkout code
         uses: actions/checkout@v4
         with:
@@ -168,23 +186,27 @@ jobs:
           python -m pip install PyOpenGL PySide2
       - name: Build USD
         run: |
-          REM Unset BOOST_ROOT on Windows. The VS2017-Win2016 image
-          REM sets this env var to a pre-installed boost which causes
-          REM the USD build to favor this over the boost built by
-          REM build_usd.py. This causes the build to fail, because
-          REM the pre-installed boost does not include boost_python27
-          call set BOOST_ROOT=
-          python build_scripts/build_usd.py --no-materialx --generator "Visual Studio 16 2019" --build USDgen/build --src USDgen/src USDinst --build-args USD,"-DPXR_ENABLE_PRECOMPILED_HEADERS=OFF" -v
-        shell: cmd          
+          # Not using '--tests' to avoid building extra dependencies that are unneeded for headless tests
+          python build_scripts/build_usd.py --no-materialx --generator "Visual Studio 16 2019" --build USDgen/build --src USDgen/src USDinst --build-args USD,"-DPXR_ENABLE_PRECOMPILED_HEADERS=OFF -DPXR_HEADLESS_TEST_MODE=ON -DPXR_BUILD_TESTS=ON" -v
+        shell: cmd
       - name: Save build artifacts to cache
         if: steps.cache-usd-build-dependency.outputs.cache-hit != 'true'
         uses: actions/cache/save@v4
         with:
           path: |
             USDinst
-          key: ${{ runner.os }}-BuildUSD-py${{ env.PYTHON_VERSION }}-${{ hashFiles('build_scripts/**/*') }}
+          key: ${{ steps.cache-usd-build-dependency.outputs.cache-primary-key }}
       - name: Upload artifacts
         uses: actions/upload-artifact@v4
         with:
           name: usd-win64
-          path: USDinst
+          path: USDinst
+      - name: Test USD
+        working-directory: ./USDgen/build/OpenUSD
+        run: |
+          call set PATH=D:\a\OpenUSD\OpenUSD\USDinst\bin;D:\a\OpenUSD\OpenUSD\USDinst\lib;D:\a\OpenUSD\OpenUSD\USDinst\share\usd\examples\plugin;D:\a\OpenUSD\OpenUSD\USDinst\plugin\usd;%PATH%
+          call set PYTHONPATH=D:\a\OpenUSD\OpenUSD\USDinst\lib\python;%PYTHONPATH%
+          # Internal ticket USD-8035
+          ctest -V -C Release --exclude-regex "TfPathUtils"
+        shell: cmd
+

.github/workflows/pypi.yml

@@ -40,7 +40,7 @@ jobs:
           - TAG: cp312
             INTERPRETER: /opt/python/cp312-cp312/bin/python
             VERSION_SPEC: '3.12'
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     timeout-minutes: 60
     steps:
       - name: Checkout code
@@ -257,23 +257,23 @@ jobs:
         BUILD_CONFIG:
           - NAME: Linux_Python38
             PYTHON_VERSION_SPEC: '3.8'
-            IMAGE: ubuntu-20.04
+            IMAGE: ubuntu-22.04
             PYTHON_INTERPRETER: python3
           - NAME: Linux_Python39
             PYTHON_VERSION_SPEC: '3.9'
-            IMAGE: ubuntu-20.04
+            IMAGE: ubuntu-22.04
             PYTHON_INTERPRETER: python3
           - NAME: Linux_Python310
             PYTHON_VERSION_SPEC: '3.10'
-            IMAGE: ubuntu-20.04
+            IMAGE: ubuntu-22.04
             PYTHON_INTERPRETER: python3
           - NAME: Linux_Python311
             PYTHON_VERSION_SPEC: '3.11'
-            IMAGE: ubuntu-20.04
+            IMAGE: ubuntu-22.04
             PYTHON_INTERPRETER: python3
           - NAME: Linux_Python312
             PYTHON_VERSION_SPEC: '3.12'
-            IMAGE: ubuntu-20.04
+            IMAGE: ubuntu-22.04
             PYTHON_INTERPRETER: python3
           - NAME: Mac_Python38
             PYTHON_VERSION_SPEC: '3.8'

BUILDING.md

@@ -333,9 +333,9 @@ Alembic library specified in ALEMBIC_DIR.
 
 See [3rd Party Library and Application Versions](VERSIONS.md) for version information.
 
-Support for Alembic files using the HDF5 backend is enabled by default but can be
-disabled by specifying the cmake flag `PXR_ENABLE_HDF5_SUPPORT=FALSE`. HDF5
-support requires the following dependencies:
+Support for Alembic files using the HDF5 backend can be enabled by specifying
+the cmake flag `PXR_ENABLE_HDF5_SUPPORT=TRUE`. HDF5 support requires the
+following dependencies:
 
 | Dependency Name    | Description     |
 | ------------------ |---------------- |
@@ -469,25 +469,6 @@ pxr/pxr.h, which facilitates using namespaces:
 | PXR_NS                         | Explicit qualification on items, e.g. `PXR_NS::TfToken foo = ...`|
 | PXR_NAMESPACE_USING_DIRECTIVE  | Enacts a using-directive, e.g. `using namespace PXR_NS;`         |
 
-##### ASCII Parser Editing/Validation
-
-There is an ASCII parser for the USD file format, which can be found in
-[sdf](pxr/usd/sdf). Most users will not have a need to edit the parser, but
-for the adventurous ones, there are a couple additional requirements.
-
-If you choose to edit the ASCII parsers, make sure
-`PXR_VALIDATE_GENERATED_CODE` is set to `TRUE`.  This flag enables tests
-that check the generated code in [sdf](pxr/usd/lib/sdf) and
-[gf](pxr/base/lib/gf).
-
-| Dependency Name    | Description                                             |
-| ------------------ | ------------------------------------------------------- |
-| FLEX_EXECUTABLE    | Path to [flex](http://flex.sourceforge.net/) executable |
-| BISON_EXECUTABLE   | Path to [bison](https://www.gnu.org/software/bison/) executable  |
-
-See [3rd Party Library and Application Versions](VERSIONS.md) for version information.
-
-
 ##### USD Schema Generation
 
 USD generates some code through a process called [schema