chore(Build/Package Management): Begin to setup and implement uv for package management #1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # This workflow will install Python dependencies, run tests and lint with a variety of Python versions | |
| # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions | |
| name: OpenTimelineIO w/ uv | |
| # for configuring which build will be a C++ coverage build / coverage report | |
| env: | |
| GH_COV_PY: "3.10" | |
| GH_COV_OS: ubuntu-latest | |
| GH_DEPENDABOT: dependabot | |
| on: | |
| push: | |
| branches: [ main ] | |
| pull_request: | |
| branches: [ main ] | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| cpp_build: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, macos-latest] | |
| # Unfortunately the CMake test target is OS dependent so we set it as | |
| # a variable here. | |
| include: | |
| - os: ubuntu-latest | |
| OTIO_TEST_TARGET: test | |
| - os: macos-latest | |
| OTIO_TEST_TARGET: test | |
| env: | |
| OTIO_BUILD_CONFIG: Release | |
| OTIO_BUILD_DIR: ${{ github.workspace }}/build | |
| OTIO_INSTALL_DIR: ${{ github.workspace }}/install | |
| OTIO_CONSUMER_TEST_BUILD_DIR: ${{ github.workspace }}/consumertest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: 'recursive' | |
| - name: Install coverage dependency | |
| if: matrix.os == env.GH_COV_OS && github.actor != env.GH_DEPENDABOT | |
| run: | | |
| sudo apt-get install lcov | |
| - name: Build | |
| run: | | |
| cmake -E make_directory ${{ env.OTIO_BUILD_DIR }} | |
| cd ${{ env.OTIO_BUILD_DIR }} | |
| cmake ${{ github.workspace }} -DCMAKE_INSTALL_PREFIX=${{ env.OTIO_INSTALL_DIR }} -DOTIO_SHARED_LIBS=OFF -DOTIO_CXX_COVERAGE=ON | |
| cmake --build . --config ${{ env.OTIO_BUILD_CONFIG }} | |
| - name: Run tests | |
| run: | | |
| cd ${{ env.OTIO_BUILD_DIR }} | |
| cmake --build . --target ${{ matrix.OTIO_TEST_TARGET }} --config ${{ env.OTIO_BUILD_CONFIG }} | |
| - name: Collect code coverage | |
| if: matrix.os == env.GH_COV_OS && github.actor != env.GH_DEPENDABOT | |
| run: | | |
| cd ${{ env.OTIO_BUILD_DIR }} | |
| lcov --rc lcov_branch_coverage=1 --rc no_exception_branch=1 --ignore-errors mismatch --capture -b . --directory . --output-file=coverage.info -q | |
| cat coverage.info | sed "s/SF:.*src/SF:src/g" > coverage.filtered.info | |
| lcov --remove coverage.filtered.info '*/tests/*' --output-file=coverage.filtered.info -q | |
| lcov --list coverage.filtered.info | |
| # TODO: Should the Codecov web pages show the results of the C++ or Python tests? | |
| - name: Upload coverage to Codecov | |
| if: matrix.os == env.GH_COV_OS && github.actor != env.GH_DEPENDABOT | |
| uses: codecov/[email protected] | |
| with: | |
| files: ${{ env.OTIO_BUILD_DIR }}/coverage.filtered.info | |
| flags: unittests | |
| name: opentimelineio-codecov | |
| fail_ci_if_error: true | |
| - name: Install | |
| run: | | |
| cd ${{ env.OTIO_BUILD_DIR }} | |
| cmake --build . --target install --config ${{ env.OTIO_BUILD_CONFIG }} | |
| - name: Consumer tests | |
| run: | | |
| cmake -E make_directory ${{ env.OTIO_CONSUMER_TEST_BUILD_DIR }} | |
| cd ${{ env.OTIO_CONSUMER_TEST_BUILD_DIR }} | |
| cmake ${{ github.workspace }}/tests/consumer -DCMAKE_PREFIX_PATH=${{ env.OTIO_INSTALL_DIR }} | |
| py_build_test: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, macos-latest] | |
| # python-version: ['3.7', '3.8', '3.9', '3.10', '3.11', '3.12'] | |
| python-version: ['3.11', '3.12'] | |
| # No include/exclude needed for this simplified matrix yet | |
| # No shell specification needed, uv handles environment activation | |
| env: | |
| OTIO_CXX_COVERAGE_BUILD: ON | |
| OTIO_CXX_BUILD_TMP_DIR: ${{ github.workspace }}/build | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: 'recursive' | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v3 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| run: uv python install ${{ matrix.python-version }} | |
| - name: Install C++ coverage dependency (Linux only) | |
| if: matrix.os == 'ubuntu-latest' && matrix.python-version == env.GH_COV_PY && github.actor != env.GH_DEPENDABOT | |
| run: | | |
| echo 'OTIO_CXX_DEBUG_BUILD=1' >> $GITHUB_ENV | |
| sudo apt-get update && sudo apt-get install -y lcov | |
| - name: Install project and development dependencies | |
| run: | | |
| uv sync --all-extras --dev | |
| - name: Run check-manifest and lint check | |
| run: uv run make ci-prebuild | |
| - name: Run tests w/ python coverage | |
| run: uv run make ci-postbuild | |
| # (only on ubuntu/specific python version) | |
| - name: Generate C++ coverage report | |
| if: matrix.os == 'ubuntu-latest' && matrix.python-version == env.GH_COV_PY && github.actor != env.GH_DEPENDABOT | |
| run: uv run make lcov | |
| - name: Upload coverage to Codecov | |
| if: matrix.os == 'ubuntu-latest' && matrix.python-version == env.GH_COV_PY && github.actor != env.GH_DEPENDABOT | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| flags: py-unittests | |
| name: py-opentimelineio-codecov | |
| fail_ci_if_error: false | |
| env: | |
| # based on: https://github.com/codecov/codecov-action?tab=readme-ov-file#usage | |
| CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} | |
| package_wheels: | |
| needs: py_build_test | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, ubuntu-24.04-arm, macos-latest] | |
| python-build: ['cp311', 'cp312'] | |
| exclude: | |
| - { os: macos-latest, python-build: 'cp37' } | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Build wheels (Python 3) | |
| uses: pypa/[email protected] | |
| with: | |
| output-dir: wheelhouse | |
| env: | |
| CIBW_BUILD: ${{ matrix.python-build }}* | |
| CIBW_SKIP: '*musllinux*' | |
| CIBW_ARCHS_LINUX: native | |
| CIBW_MANYLINUX_X86_64_IMAGE: manylinux2014 | |
| CIBW_MANYLINUX_AARCH64_IMAGE: manylinux2014 | |
| MACOSX_DEPLOYMENT_TARGET: 10.14 | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: wheel-${{ matrix.os }}-${{ matrix.python-build }} | |
| path: ./wheelhouse/*.whl | |
| package_sdist: | |
| needs: py_build_test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: 'recursive' | |
| - uses: actions/[email protected] | |
| - name: Install pypa/build | |
| run: python -m pip install build --user | |
| - name: Generate sdist | |
| run: python -m build -s . | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: sdist | |
| path: dist |