feat: use uv lock file

.github/workflows/ci_cd_pr.yml

@@ -124,6 +124,7 @@ jobs:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
           use-python-cache: false
           checkout: false
+          skip-install: false
 
   type-check:
     name: Type check with Ty

.github/workflows/ci_cd_pr_flit.yml

@@ -87,7 +87,7 @@ jobs:
   test-build-library-flit:
     name: "Test build-library action (use-uv: ${{ matrix.use-uv }}) using ansys-actions-flit package"
     runs-on: ubuntu-latest
-    needs: test-build-wheelhouse-flit
+    # needs: test-build-wheelhouse-flit
     strategy:
       matrix:
         use-uv: ['true', 'false']
@@ -173,11 +173,12 @@ jobs:
           operating-system: ${{ matrix.os }}
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
           attest-provenance: true
+          use-uv-lockfile: ${{ matrix.repository.name == 'pyansys-geometry' }}
+          use-uv: ${{ matrix.repository.name == 'pyansys-geometry' }}
 
   test-build-library-flit-projects:
     name: "Test build-library action for ${{ matrix.repository.name }} project"
     runs-on: ubuntu-latest
-    needs: test-build-wheelhouse-flit-projects
     strategy:
       matrix:
         repository:
@@ -195,7 +196,6 @@ jobs:
       contents: read
       attestations: write # Needed for provenance attestation
     steps:
-
       - name: "Install Git and clone ${{ matrix.repository.name }} repository"
         uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
         with:
@@ -216,6 +216,8 @@ jobs:
           library-name: ${{ matrix.repository.library }}
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
           attest-provenance: true
+          use-uv-lockfile: ${{ matrix.repository.name == 'pyansys-geometry' }}
+          use-uv: ${{ matrix.repository.name == 'pyansys-geometry' }}
 
   test-check-licenses-flit-projects:
     name: "Test check-licenses action for ${{ matrix.repository.name }} project"
@@ -291,6 +293,9 @@ jobs:
           use-python-cache: false
           use-prek: ${{ matrix.use-prek }}
           checkout: false
+          use-uv-lockfile: ${{ matrix.repository.name == 'pyansys-geometry' }}
+          use-uv: ${{ matrix.repository.name == 'pyansys-geometry' }}
+          skip-install: false
 
   test-doc-style-flit-projects:
     name: "Test doc-style action for ${{ matrix.repository.name }} project"

build-library/action.yml

@@ -121,6 +121,18 @@ inputs:
     required: false
     type: boolean
 
+  use-uv-lockfile:
+    description: |
+      Whether to use a uv lockfile when installing dependencies.
+
+      .. note::
+
+        This option is only applicable when ``use-uv`` is set to ``true``. If
+        ``use-uv`` is set to ``false``, this option is ignored.
+    default: false
+    required: false
+    type: boolean
+
   skip-python-setup:
     description: |
       Whether to skip the Python setup step performed by
@@ -164,7 +176,46 @@ runs:
         message: >
           Skipping Python setup to use system Python.
 
+    # ------------------------------------------------------------------------
+    # Install package by leveraging uv lockfile if requested and available
+    # ------------------------------------------------------------------------
+
+    - name: "Validate uv lockfile existence"
+      id: validate-uv-lockfile
+      if: ${{ inputs.use-uv == 'true' && inputs.use-uv-lockfile == 'true' }}
+      shell: bash
+      env:
+        WORKING_DIRECTORY: ${{ inputs.working-directory }}
+      run: |
+        if [[ ! -f "${WORKING_DIRECTORY}/uv.lock" ]]; then
+          echo "UV_LOCKFILE_MISSING=true" >> ${GITHUB_OUTPUT}
+        else
+          echo "UV_LOCKFILE_MISSING=false" >> ${GITHUB_OUTPUT}
+        fi
+
+    - uses: ansys/actions/_logging@main
+      if: ${{ steps.validate-uv-lockfile.outputs.UV_LOCKFILE_MISSING == 'true' }}
+      with:
+        level: "ERROR"
+        message: >
+          uv lockfile (uv.lock) not found in ${{ inputs.working-directory }}
+
+    - name: "Install dependencies from uv lockfile"
+      if: ${{ inputs.use-uv == 'true' && inputs.use-uv-lockfile == 'true' }}
+      shell: bash
+      env:
+        WORKING_DIRECTORY: ${{ inputs.working-directory }}
+      run: |
+        cd ${WORKING_DIRECTORY}
+        uv export --frozen --no-emit-project --no-hashes -o /tmp/requirements-locked.txt
+        uv pip install --no-managed-python --system -r /tmp/requirements-locked.txt
+
+    # ------------------------------------------------------------------------
+    # Install package without leveraging uv lockfile
+    # ------------------------------------------------------------------------
+
     - name: "Install library"
+      if: ${{ inputs.use-uv != 'true' || inputs.use-uv-lockfile != 'true' }}
       shell: bash
       env:
         INSTALL_COMMAND: ${{ inputs.use-uv == 'true' && 'uv pip install --no-managed-python --system' || 'python -m pip install' }}

build-wheelhouse/action.yml

@@ -149,6 +149,18 @@ inputs:
     required: false
     type: boolean
 
+  use-uv-lockfile:
+    description: |
+      Whether to use a uv lockfile when installing dependencies.
+
+      .. note::
+
+        This option is only applicable when ``use-uv`` is set to ``true``. If
+        ``use-uv`` is set to ``false``, this option is ignored.
+    default: false
+    required: false
+    type: boolean
+
   skip-python-setup:
     description: |
       Whether to skip the Python setup step performed by
@@ -290,10 +302,33 @@ runs:
           python -m pip install -U pip
         fi
 
+    - name: "Validate uv lockfile existence"
+      id: validate-uv-lockfile
+      if: ${{ inputs.use-uv == 'true' && inputs.use-uv-lockfile == 'true' }}
+      shell: bash
+      env:
+        WORKING_DIRECTORY: ${{ inputs.working-directory }}
+      run: |
+        if [[ ! -f "${WORKING_DIRECTORY}/uv.lock" ]]; then
+          echo "UV_LOCKFILE_MISSING=true" >> ${GITHUB_OUTPUT}
+        else
+          echo "UV_LOCKFILE_MISSING=false" >> ${GITHUB_OUTPUT}
+        fi
+
+    - uses: ansys/actions/_logging@main
+      if: ${{ steps.validate-uv-lockfile.outputs.UV_LOCKFILE_MISSING == 'true' }}
+      with:
+        level: "ERROR"
+        message: >
+          uv lockfile (uv.lock) not found in repository root
+
     - name: "Install the library with the desired targets"
       env:
         INSTALL_COMMAND: ${{ inputs.use-uv == 'true' && 'uv pip install --no-managed-python' || 'python -m pip install' }}
         INSTALL_TARGET: ${{ steps.specific-target-requested.outputs.install_target }}
+        TARGET: ${{ inputs.target }}
+        USE_UV: ${{ inputs.use-uv }}
+        USE_UV_LOCKFILE: ${{ inputs.use-uv-lockfile }}
         ACTIVATE_VENV: ${{ steps.virtual-environment-activation-command.outputs.ACTIVATE_VENV }}
         BUILD_BACKEND: ${{ steps.build-system.outputs.BUILD_BACKEND }}
         WORKING_DIRECTORY: ${{ inputs.working-directory }}
@@ -303,6 +338,12 @@ runs:
         cd ${WORKING_DIRECTORY}
         if [[ "${BUILD_BACKEND}" == 'poetry' ]]; then
           poetry install ${INSTALL_TARGET}
+        elif [[ "${USE_UV}" == 'true' && "${USE_UV_LOCKFILE}" == 'true' ]]; then
+          if [[ "${TARGET}" != '' ]]; then
+            uv sync --frozen --extra "${TARGET}" --no-dev
+          else
+            uv sync --frozen --no-dev
+          fi
         else
            ${INSTALL_COMMAND} "${INSTALL_TARGET}"
         fi
@@ -410,6 +451,8 @@ runs:
         ACTIVATE_VENV: ${{ steps.virtual-environment-activation-command.outputs.ACTIVATE_VENV }}
         BUILD_BACKEND: ${{ steps.build-system.outputs.BUILD_BACKEND }}
         INSTALL_COMMAND: ${{ inputs.use-uv == 'true' && 'uv pip install --no-managed-python' || 'python -m pip install' }}
+        USE_UV: ${{ inputs.use-uv }}
+        USE_UV_LOCKFILE: ${{ inputs.use-uv-lockfile }}
       run: |
         ${ACTIVATE_VENV}
         if [[ "${BUILD_BACKEND}" == 'poetry' ]]; then

build-wheelhouse/smoke_test.py

@@ -70,7 +70,7 @@ def find_module_from_dist(pkg_name: str, attr: str):
         if pth_file:
             source_code_folder = None
             # Read the .pth file to find the source code path
-            with Path(pth_file).open("r") as file:
+            with Path(str(dist.locate_file(pth_file))).open("r") as file:
                 for line in file:
                     # Check if the path is a valid directory
                     path = Path(line.strip())

check-vulnerabilities/action.yml

@@ -219,6 +219,18 @@ inputs:
     required: false
     type: boolean
 
+  use-uv-lockfile:
+    description: |
+      Whether to use a uv lockfile when installing dependencies.
+
+      .. note::
+
+        This option is only applicable when ``use-uv`` is set to ``true``. If
+        ``use-uv`` is set to ``false``, this option is ignored.
+    default: false
+    required: false
+    type: boolean
+
 runs:
   using: "composite"
   steps:
@@ -277,6 +289,24 @@ runs:
         message: >
           Build backend: ${{ steps.github-environment-variables.outputs.BUILD_BACKEND }}
 
+    - name: "Validate uv lockfile existence"
+      id: validate-uv-lockfile
+      if: ${{ inputs.use-uv == 'true' && inputs.use-uv-lockfile == 'true' && inputs.skip-install == 'false' }}
+      shell: bash
+      run: |
+        if [[ ! -f "uv.lock" ]]; then
+          echo "UV_LOCKFILE_MISSING=true" >> ${GITHUB_OUTPUT}
+        else
+          echo "UV_LOCKFILE_MISSING=false" >> ${GITHUB_OUTPUT}
+        fi
+
+    - uses: ansys/actions/_logging@main
+      if: ${{ steps.validate-uv-lockfile.outputs.UV_LOCKFILE_MISSING == 'true' }}
+      with:
+        level: "ERROR"
+        message: >
+          uv lockfile (uv.lock) not found in repository root
+
     # ------------------------------------------------------------------------
 
     - uses: ansys/actions/_logging@main
@@ -376,29 +406,41 @@ runs:
         BUILD_BACKEND: ${{ steps.github-environment-variables.outputs.BUILD_BACKEND }}
         ACTIVATE_VENV: ${{ steps.virtual-environment-activation-command.outputs.ACTIVATE_VENV }}
         EXTRA_TARGETS: ${{ inputs.extra-targets }}
+        USE_UV_LOCKFILE: ${{ inputs.use-uv-lockfile }}
       # Note: we need to use an array to store the extra targets, otherwise
       # the shell expansion messes with the quotes in the poetry case.
       run: |
         ${ACTIVATE_VENV}
-        if [[ "${EXTRA_TARGETS}" != '' ]]; then
-          if [[ "${BUILD_BACKEND}" == 'poetry' ]]; then
-            echo "Installing extra targets with poetry: ${EXTRA_TARGETS}"
-            extra_targets=${EXTRA_TARGETS}
+        # Use uv lockfile if requested and the build backend is uv
+        if [[ "${USE_UV_LOCKFILE}" == 'true' && "${BUILD_BACKEND}" == 'uv' ]]; then
+          if [[ "${EXTRA_TARGETS}" != '' ]]; then
+            uv sync --frozen --extra "${EXTRA_TARGETS}" --no-dev
           else
-            echo "Installing extra targets with pip: ${EXTRA_TARGETS}"
-            extra_targets=[${EXTRA_TARGETS}]
+            uv sync --frozen --no-dev
           fi
+        # Use other installation methods if uv lockfile is not requested or the build backend is not uv
         else
-          echo "No extra targets to install"
-          extra_targets=""
-        fi
-
-        if [[ "${BUILD_BACKEND}" == 'poetry' ]]; then
-          poetry install --extras "${extra_targets}"
-        elif [[ "${BUILD_BACKEND}" == 'uv' ]]; then
-          uv pip install ."${extra_targets}"
-        else
-          python -m pip install ."${extra_targets}"
+          # 1. Define the extra targets to be installed based on the build backend and the provided input
+          if [[ "${EXTRA_TARGETS}" != '' ]]; then
+            if [[ "${BUILD_BACKEND}" == 'poetry' ]]; then
+              echo "Installing extra targets with poetry: ${EXTRA_TARGETS}"
+              extra_targets=${EXTRA_TARGETS}
+            else
+              echo "Installing extra targets with pip: ${EXTRA_TARGETS}"
+              extra_targets=[${EXTRA_TARGETS}]
+            fi
+          else
+            echo "No extra targets to install"
+            extra_targets=""
+          fi
+          # 2. Trigger the installation command based on the build backend
+          if [[ "${BUILD_BACKEND}" == 'poetry' ]]; then
+            poetry install --extras "${extra_targets}"
+          elif [[ "${BUILD_BACKEND}" == 'uv' ]]; then
+            uv pip install ."${extra_targets}"
+          else
+            python -m pip install ."${extra_targets}"
+          fi
         fi
 
     - name: "Check if requirements.txt file exists"
@@ -410,6 +452,17 @@ runs:
       run: |
         echo "EXISTS_REQUIREMENTS=$(if [ -f requirements/requirements_${EXTRA_TARGETS}.txt ]; then echo 'true'; else echo 'false'; fi)" >> $GITHUB_OUTPUT
 
+    - uses: ansys/actions/_logging@main
+      if: ${{ inputs.skip-install == 'true' && inputs.use-uv-lockfile == 'true' && steps.check-exists-requirements-file.outputs.EXISTS_REQUIREMENTS == 'true' }}
+      with:
+        level: "ERROR"
+        message: >
+          ``use-uv-lockfile`` is enabled, but ``skip-install`` is also enabled and
+          a requirements file exists. Please, either use the lock file or the requirements
+          file, but not both. If you want to use the lock file, remove the requirements file
+          from the repository. If you want to use the requirements file, disable
+          ``use-uv-lockfile``.
+
     - name: "Install dependencies from the requirements file"
       shell: bash
       if: ${{ (inputs.skip-install == 'true' ) && (steps.check-exists-requirements-file.outputs.EXISTS_REQUIREMENTS == 'true') }}

code-style/action.yml

@@ -131,6 +131,18 @@ inputs:
     required: false
     type: boolean
 
+  use-uv-lockfile:
+    description: |
+      Whether to use a uv lockfile when installing dependencies.
+
+      .. note::
+
+        This option is only applicable when ``use-uv`` is set to ``true`` and
+        ``skip-install`` is set to ``false``. Otherwise, this option is ignored.
+    default: false
+    required: false
+    type: boolean
+
   checkout:
     description: |
       Whether to do a checkout step or not. If ``true``, the checkout step is performed.
@@ -255,6 +267,24 @@ runs:
 
     # ------------------------------------------------------------------------
 
+    - name: "Validate uv lockfile existence"
+      id: validate-uv-lockfile
+      if: ${{ inputs.use-uv == 'true' && inputs.use-uv-lockfile == 'true' && inputs.skip-install == 'false' }}
+      shell: bash
+      run: |
+        if [[ ! -f "uv.lock" ]]; then
+          echo "UV_LOCKFILE_MISSING=true" >> ${GITHUB_OUTPUT}
+        else
+          echo "UV_LOCKFILE_MISSING=false" >> ${GITHUB_OUTPUT}
+        fi
+
+    - uses: ansys/actions/_logging@main
+      if: ${{ steps.validate-uv-lockfile.outputs.UV_LOCKFILE_MISSING == 'true' }}
+      with:
+        level: "ERROR"
+        message: >
+          uv lockfile (uv.lock) not found in repository root
+
     - name: "Update pip"
       shell: bash
       env:
@@ -274,12 +304,17 @@ runs:
       env:
         BUILD_BACKEND: ${{ steps.github-environment-variables.outputs.BUILD_BACKEND }}
         ACTIVATE_VENV: ${{ steps.virtual-environment-activation-command.outputs.ACTIVATE_VENV }}
+        USE_UV_LOCKFILE: ${{ inputs.use-uv-lockfile }}
       run: |
         ${ACTIVATE_VENV}
         if [[ "${BUILD_BACKEND}" == 'poetry' ]]; then
           poetry install
         elif [[ "${BUILD_BACKEND}" == 'uv' ]]; then
-          uv pip install .
+          if [[ "${USE_UV_LOCKFILE}" == 'true' ]]; then
+            uv sync --frozen --no-dev
+          else
+            uv pip install .
+          fi
         else
           python -m pip install .
         fi

doc/source/changelog/1427.added.md

@@ -0,0 +1 @@
+Use uv lock file