python.yml

name: ♻ python

on:
  workflow_call:
    inputs:
      runs_on:
        description: The label of the runner (GitHub- or self-hosted) to run this workflow on. Defaults to `ubuntu-24.04`.
        type: string
        required: false
        default: ubuntu-24.04

      working_directory:
        description: The path of the directory containing the Python application.
        type: string
        required: false
        default: "."

      python_version:
        description: The version of Python to install.
        type: string
        required: false
        default: latest

      venv_path:
        description: The path to create a virtual Python environment at (relative to working directory).
        type: string
        required: false

      pip_install_target:
        description: The target directory that PIP should install packages into (relative to working directory).
        type: string
        required: false

      artifact_name:
        description: The name of the build artifact to upload.
        type: string
        required: false
        default: python-app

    outputs:
      artifact_name:
        description: The name of the uploaded artifact containing the application.
        value: ${{ inputs.artifact_name }}

permissions: {}

jobs:
  python:
    name: Python
    runs-on: ${{ inputs.runs_on }}
    permissions:
      contents: read # Required to checkout the repository

    defaults:
      run:
        shell: bash
        working-directory: ${{ inputs.working_directory }}

    steps:
      - name: Checkout
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683

      - name: Setup Python
        uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b
        with:
          python-version: ${{ inputs.python_version }}

      - name: Create and activate virtual environment
        if: inputs.venv_path != ''
        env:
          VENV_PATH: ${{ inputs.venv_path }}
        run: |
          python -m venv "$VENV_PATH"
          source "$VENV_PATH/bin/activate"

      - name: Install dependencies
        env:
          TARGET: ${{ inputs.pip_install_target }}
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt --target "$TARGET"

      - name: Create tarball
        id: tar
        run: |
          tarball="$RUNNER_TEMP/$ARTIFACT_NAME.tar"
          tar -cvf "$tarball" .
          echo "tarball=$tarball" >> "$GITHUB_OUTPUT"

      - name: Upload artifact
        uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08
        with:
          name: ${{ inputs.artifact_name }}
          path: ${{ steps.tar.outputs.tarball }}