Refactor Docker build/publish workflow to GHCR, drop usdzconvert

Moved Docker image publishing from Docker Hub to GitHub Container Registry. The new GitHub Actions workflow now uses `docker buildx` for streamlined multi-architecture (amd64, arm64) builds and manifest list creation.

The `usdzconvert` toolchain has been removed from the Docker image, refocusing its purpose solely on compiling Apple's AR schemas into OpenUSD.

Updated `Dockerfile`, local build/utility scripts, and `README.md` to reflect these changes and improve maintainability.

Author: DavidArayan

.github/workflows/publish.yml

@@ -1,84 +1,181 @@
 name: docker publish
+
 on:
   push:
     tags:
       - '*'
+  workflow_dispatch:
+    inputs:
+      usd_version:
+        description: 'OpenUSD version to build (e.g. 26.05). The ghcr.io/plattar/python-usd:version-<usd_version> base image must already exist.'
+        required: true
+        default: '26.05'
+        type: string
+      image_tag:
+        description: 'Image tag to publish (defaults to the OpenUSD version above).'
+        required: false
+        default: ''
+        type: string
+      tag_latest:
+        description: 'Also publish the image as :latest.'
+        required: false
+        default: false
+        type: boolean
+
+env:
+  REGISTRY: ghcr.io
+
 jobs:
-  build-amd64:
+  setup:
     runs-on: ubuntu-latest
-    timeout-minutes: 360
+    outputs:
+      usd_version: ${{ steps.derive.outputs.usd_version }}
+      image_tag:   ${{ steps.derive.outputs.image_tag }}
+      image_name:  ${{ steps.derive.outputs.image_name }}
+      tag_latest:  ${{ steps.derive.outputs.tag_latest }}
     steps:
-      - name: checkout code
-        uses: actions/checkout@v3
-      - name: setup qemu
-        uses: docker/setup-qemu-action@v2
-      - name: setup buildx
-        id: buildx
-        uses: docker/setup-buildx-action@v2
-      - name: print available platforms
-        run: echo ${{ steps.buildx.outputs.platforms }}
-      - name: set version from tag
-        run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
-      - name: print version number
-        run: echo ${{ env.RELEASE_VERSION }}
-      - name: login to dockerhub
-        uses: docker/login-action@v2
-        with:
-          username: ${{ secrets.DOCKER_UPLOAD_USERNAME }}
-          password: ${{ secrets.DOCKER_UPLOAD_TOKEN }}
-      - name: build & upload
+      - name: derive build parameters
+        id: derive
         run: |
-          docker buildx build \
-          --push \
-          --tag plattar/python-usd-ar:version-${{ env.RELEASE_VERSION }}-amd64 \
-          --platform linux/amd64 \
-          --file Dockerfile .
-  build-arm64:
-    runs-on: ubuntu-latest
+          set -euo pipefail
+
+          if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
+            usd_version="${{ inputs.usd_version }}"
+            image_tag="${{ inputs.image_tag }}"
+            tag_latest="${{ inputs.tag_latest }}"
+          else
+            ref="${GITHUB_REF#refs/tags/}"
+            usd_version="${ref#v}"
+            image_tag="$ref"
+            tag_latest="true"
+          fi
+
+          if [[ -z "$image_tag" ]]; then
+            image_tag="$usd_version"
+          fi
+
+          image_name="$(echo "${{ github.repository_owner }}/python-usd-ar" | tr '[:upper:]' '[:lower:]')"
+
+          echo "usd_version=$usd_version" >> "$GITHUB_OUTPUT"
+          echo "image_tag=$image_tag"     >> "$GITHUB_OUTPUT"
+          echo "image_name=$image_name"   >> "$GITHUB_OUTPUT"
+          echo "tag_latest=$tag_latest"   >> "$GITHUB_OUTPUT"
+
+          echo "Building OpenUSD v${usd_version} -> ${{ env.REGISTRY }}/${image_name}:${image_tag} (latest=${tag_latest})"
+
+  build:
+    needs: setup
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - platform: linux/amd64
+            runner:   ubuntu-latest
+          - platform: linux/arm64
+            runner:   ubuntu-24.04-arm
+    runs-on: ${{ matrix.runner }}
     timeout-minutes: 360
+    permissions:
+      contents: read
+      packages: write
     steps:
+      - name: prepare platform pair
+        run: |
+          platform="${{ matrix.platform }}"
+          echo "PLATFORM_PAIR=${platform//\//-}" >> "$GITHUB_ENV"
+
       - name: checkout code
-        uses: actions/checkout@v3
-      - name: setup qemu
-        uses: docker/setup-qemu-action@v2
+        uses: actions/checkout@v4
+
       - name: setup buildx
-        id: buildx
-        uses: docker/setup-buildx-action@v2
-      - name: print available platforms
-        run: echo ${{ steps.buildx.outputs.platforms }}
-      - name: set version from tag
-        run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
-      - name: print version number
-        run: echo ${{ env.RELEASE_VERSION }}
-      - name: login to dockerhub
-        uses: docker/login-action@v2
+        uses: docker/setup-buildx-action@v3
+
+      - name: login to GHCR
+        uses: docker/login-action@v3
         with:
-          username: ${{ secrets.DOCKER_UPLOAD_USERNAME }}
-          password: ${{ secrets.DOCKER_UPLOAD_TOKEN }}
-      - name: build & upload
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: build and push by digest
+        id: build
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: Dockerfile
+          platforms: ${{ matrix.platform }}
+          build-args: |
+            USD_VERSION=${{ needs.setup.outputs.usd_version }}
+          labels: |
+            org.opencontainers.image.title=python-usd-ar
+            org.opencontainers.image.version=${{ needs.setup.outputs.image_tag }}
+            org.opencontainers.image.revision=${{ github.sha }}
+            org.opencontainers.image.source=https://github.com/${{ github.repository }}
+          outputs: type=image,name=${{ env.REGISTRY }}/${{ needs.setup.outputs.image_name }},push-by-digest=true,name-canonical=true,push=true
+
+      - name: export digest
         run: |
-          docker buildx build \
-          --push \
-          --tag plattar/python-usd-ar:version-${{ env.RELEASE_VERSION }}-arm64 \
-          --platform linux/arm64 \
-          --file Dockerfile .
-  build-manifest:
+          mkdir -p /tmp/digests
+          digest="${{ steps.build.outputs.digest }}"
+          touch "/tmp/digests/${digest#sha256:}"
+
+      - name: upload digest
+        uses: actions/upload-artifact@v4
+        with:
+          name: digests-${{ env.PLATFORM_PAIR }}
+          path: /tmp/digests/*
+          if-no-files-found: error
+          retention-days: 1
+
+  merge:
+    needs: [setup, build]
     runs-on: ubuntu-latest
-    timeout-minutes: 360
-    needs: [build-amd64, build-arm64]
+    permissions:
+      contents: read
+      packages: write
     steps:
-      - name: checkout code
-        uses: actions/checkout@v3
-      - name: set version from tag
-        run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
-      - name: print version number
-        run: echo ${{ env.RELEASE_VERSION }}
-      - name: login to dockerhub
-        uses: docker/login-action@v2
+      - name: download digests
+        uses: actions/download-artifact@v4
+        with:
+          path: /tmp/digests
+          pattern: digests-*
+          merge-multiple: true
+
+      - name: setup buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: login to GHCR
+        uses: docker/login-action@v3
         with:
-          username: ${{ secrets.DOCKER_UPLOAD_USERNAME }}
-          password: ${{ secrets.DOCKER_UPLOAD_TOKEN }}
-      - name: create manifest
-        run: docker manifest create plattar/python-usd-ar:version-${{ env.RELEASE_VERSION }} plattar/python-usd-ar:version-${{ env.RELEASE_VERSION }}-amd64 plattar/python-usd-ar:version-${{ env.RELEASE_VERSION }}-arm64
-      - name: upload manifest
-        run: docker manifest push plattar/python-usd-ar:version-${{ env.RELEASE_VERSION }}
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: assemble tag args
+        id: tags
+        run: |
+          set -euo pipefail
+          image="${{ env.REGISTRY }}/${{ needs.setup.outputs.image_name }}"
+          tags=("version-${{ needs.setup.outputs.image_tag }}" "${{ needs.setup.outputs.image_tag }}")
+          if [[ "${{ needs.setup.outputs.tag_latest }}" == "true" ]]; then
+            tags+=("latest")
+          fi
+          args=""
+          for t in "${tags[@]}"; do
+            args+=" -t ${image}:${t}"
+          done
+          echo "args=${args}" >> "$GITHUB_OUTPUT"
+
+      - name: create multi-arch manifest
+        working-directory: /tmp/digests
+        run: |
+          set -euo pipefail
+          image="${{ env.REGISTRY }}/${{ needs.setup.outputs.image_name }}"
+          # shellcheck disable=SC2046
+          docker buildx imagetools create ${{ steps.tags.outputs.args }} \
+            $(printf "${image}@sha256:%s " *)
+
+      - name: inspect
+        run: |
+          docker buildx imagetools inspect \
+            ${{ env.REGISTRY }}/${{ needs.setup.outputs.image_name }}:${{ needs.setup.outputs.image_tag }}

Dockerfile

@@ -1,70 +1,77 @@
-# Create a base from a pre-compiled version of USD tools
-# More info @ https://github.com/Plattar/python-usd
-# Unlike the python-usd container, python-usd-ar also contains the Schema
-# Definitions for ARKit and is useful for generating USDZ files with various
-# AR Features.
-# NOTE: As of 30/06/2022 this respository also builds and sets up 
-# usdzconvert tools
-# For more info on usdconvert, visit https://developer.apple.com/augmented-reality/tools/
-FROM plattar/python-usd:version-22.05b-slim-bullseye
+# syntax=docker/dockerfile:1.7
 
-LABEL MAINTAINER PLATTAR(www.plattar.com)
+# Python USD AR — adds Apple's "Preliminary_" AR schemas on top of python-usd.
+#
+# These schemas (Preliminary_AnchoringAPI, Preliminary_Behavior, Preliminary_Trigger,
+# Preliminary_Action, Preliminary_ReferenceImage, Preliminary_Text) come from Apple's
+# USDZ Schemas for AR addendum and are still not upstreamed into OpenUSD, so they
+# have to be code-generated and compiled into libusd at build time.
+#
+# See: https://developer.apple.com/documentation/arkit/usdz_schemas_for_ar
+ARG USD_VERSION=26.05
+FROM ghcr.io/plattar/python-usd:version-${USD_VERSION}
 
-ENV USD_SCHEMA_FOLDER="usd_schemas"
-ENV USDZCONVERT_FOLDER="usdzconvert"
-ENV USDZCONVERT_VERSION="0.66"
+LABEL org.opencontainers.image.source="https://github.com/Plattar/python-usd-ar"
+LABEL org.opencontainers.image.description="Pixar OpenUSD with Apple's Preliminary_* AR schemas compiled in"
+LABEL org.opencontainers.image.licenses="Apache-2.0"
+LABEL org.opencontainers.image.vendor="Plattar"
 
-WORKDIR /usr/src/app
+# USD_VERSION, USD_BUILD_PATH, USD_BIN_PATH, USD_LIB_PATH, USD_PLUGIN_PATH,
+# PATH, LD_LIBRARY_PATH and PYTHONPATH are inherited from the python-usd base.
+
+ENV USD_SCHEMA_FOLDER=usd_schemas
 
-# Update the environment path for USDZ Convert Tools
-ENV USDZCONVERT_BIN_PATH="/usr/src/app/xrutils/${USDZCONVERT_FOLDER}"
-ENV PATH="${PATH}:${USDZCONVERT_BIN_PATH}"
+WORKDIR /usr/src/app
 
-# copy source folders into container
-COPY /${USD_SCHEMA_FOLDER} /usr/src/app/${USD_SCHEMA_FOLDER}
-COPY /${USDZCONVERT_FOLDER} ${USDZCONVERT_BIN_PATH}
+COPY ${USD_SCHEMA_FOLDER}/ /usr/src/app/${USD_SCHEMA_FOLDER}/
 
-RUN apt-get update && apt-get install -y --no-install-recommends \
-	git \
-	build-essential \
-	cmake \
-	nasm \
-	libxrandr-dev \
-	libxcursor-dev \
-	libxinerama-dev \
-	libxi-dev && \
-	rm -rf /var/lib/apt/lists/* && \
-	# Clone the USD Repository
-	git clone --branch "v${USD_VERSION}" --depth 1 https://github.com/PixarAnimationStudios/USD.git usdsrc && \
-	# Copy the AR Schema Components into the examples folder
-	cp -a /usr/src/app/${USD_SCHEMA_FOLDER}/usdInteractive/ usdsrc/pxr/usd/ && \
-	# Use usdGenSchema to Generate all CPP source files that will be built
-	cd usdsrc/pxr/usd/usdInteractive && usdGenSchema schema.usda . && cd /usr/src/app && \
-	# Add the directories into the CMakeLists.txt so everything gets built
-	echo "add_subdirectory(usdInteractive)" >> usdsrc/pxr/usd/CMakeLists.txt && \
-	# Remove the old USD installation
-	rm -rf ${USD_BUILD_PATH} && \
-	# build a new version with our new schemas
-	python3 usdsrc/build_scripts/build_usd.py --no-examples --no-tutorials --no-imaging --no-usdview --no-draco --no-docs --no-tests ${USD_BUILD_PATH} && \
-	# remove source code as we don't need it anymore
-	rm -rf usdsrc && \
-	rm -rf ${USD_SCHEMA_FOLDER} && \
-	# remove build files we no longer need to save space
-	rm -rf ${USD_BUILD_PATH}/build && \
-	rm -rf ${USD_BUILD_PATH}/cmake && \
-	rm -rf ${USD_BUILD_PATH}/pxrConfig.cmake && \
-	rm -rf ${USD_BUILD_PATH}/share && \
-	rm -rf ${USD_BUILD_PATH}/src && \
-	# remove packages we no longer need/require
-	# this keeps the container as small as possible
-	# if others need them, they can install when extending
-	apt-get purge -y git \
-	build-essential \
-	cmake \
-	nasm \
-	libxrandr-dev \
-	libxcursor-dev \
-	libxinerama-dev \
-	libxi-dev && \
-	apt autoremove -y && \
-	apt-get autoclean -y
+RUN set -eux; \
+	apt-get update; \
+	apt-get install -y --no-install-recommends \
+		git \
+		ca-certificates \
+		build-essential \
+		cmake \
+		nasm \
+		libxrandr-dev \
+		libxcursor-dev \
+		libxinerama-dev \
+		libxi-dev; \
+	rm -rf /var/lib/apt/lists/*; \
+	git clone --branch "v${USD_VERSION}" --depth 1 https://github.com/PixarAnimationStudios/OpenUSD.git usdsrc; \
+	# Drop the Apple schema package into the OpenUSD source tree
+	cp -a /usr/src/app/${USD_SCHEMA_FOLDER}/usdInteractive/ usdsrc/pxr/usd/; \
+	# Use the inherited usdGenSchema (from the python-usd base) to turn schema.usda
+	# into C++ source. Done before re-running build_usd.py so the new sources get picked up.
+	(cd usdsrc/pxr/usd/usdInteractive && usdGenSchema schema.usda .); \
+	echo "add_subdirectory(usdInteractive)" >> usdsrc/pxr/usd/CMakeLists.txt; \
+	# Rebuild USD into the same prefix. boost/tbb/oneTBB are already present and
+	# get skipped by build_usd.py; only USD itself is recompiled (with the new schema).
+	python3 usdsrc/build_scripts/build_usd.py \
+		--no-examples \
+		--no-tutorials \
+		--no-imaging \
+		--no-usdview \
+		--no-draco \
+		--no-materialx \
+		${USD_BUILD_PATH}; \
+	rm -rf usdsrc; \
+	rm -rf /usr/src/app/${USD_SCHEMA_FOLDER}; \
+	rm -rf \
+		${USD_BUILD_PATH}/build \
+		${USD_BUILD_PATH}/cmake \
+		${USD_BUILD_PATH}/pxrConfig.cmake \
+		${USD_BUILD_PATH}/share \
+		${USD_BUILD_PATH}/src; \
+	apt-get purge -y \
+		git \
+		build-essential \
+		cmake \
+		nasm \
+		libxrandr-dev \
+		libxcursor-dev \
+		libxinerama-dev \
+		libxi-dev; \
+	apt-get autoremove -y; \
+	apt-get autoclean -y; \
+	rm -rf /var/lib/apt/lists/*