feat: convert to a uv based workflow

Author: JasonGrace2282

.github/workflows/ci.yml

@@ -31,31 +31,24 @@
                     "uses": "actions/checkout@v2"
                 },
                 {
-                    "name": "Set up Python ${{ matrix.python-version }}",
-                    "uses": "actions/setup-python@v2",
-                    "with": {
-                        "python-version": "${{ matrix.python-version }}"
-                    }
+                    "name": "Set up uv",
+                    "uses": "astral-sh/setup-uv@v5"
                 },
                 {
-                    "name": "Set up pip cache",
-                    "uses": "actions/cache@v2",
-                    "with": {
-                        "path": "~/.cache/pip",
-                        "key": "pip-${{ matrix.python-version }}"
-                    }
+                    "name": "Set up Python ${{ matrix.python-version }}",
+                    "run": "uv python install ${{ matrix.python-version }}"
                 },
                 {
                     "name": "Set up packages",
-                    "run": "set -e\n\npip install -U pip setuptools wheel\npip install -U \\\n  pre-commit coveralls pyyaml pytest-django\npip install -U -r requirements.txt\n\necho \"PATH=$PATH\" >> $GITHUB_ENV\n"
+                    "run": "uv sync --group ci --locked"
                 },
                 {
                     "name": "Copy secret.py",
                     "run": "cp intranet/settings/ci_secret.py intranet/settings/secret.py"
                 },
                 {
                     "name": "Run pre-commit",
-                    "run": "pre-commit run --all-files"
+                    "run": "uv run pre-commit run --all-files"
                 }
             ]
         },
@@ -78,40 +71,33 @@
                     }
                 },
                 {
-                    "name": "Set up Python ${{ matrix.python-version }}",
-                    "uses": "actions/setup-python@v2",
-                    "with": {
-                        "python-version": "${{ matrix.python-version }}"
-                    }
+                    "name": "Set up uv",
+                    "uses": "astral-sh/setup-uv@v5"
                 },
                 {
-                    "name": "Set up pip cache",
-                    "uses": "actions/cache@v2",
-                    "with": {
-                        "path": "~/.cache/pip",
-                        "key": "pip-${{ matrix.python-version }}"
-                    }
+                    "name": "Set up Python ${{ matrix.python-version }}",
+                    "run": "uv python install ${{ matrix.python-version }}"
                 },
                 {
                     "name": "Set up packages",
-                    "run": "set -e\n\npip install -U pip setuptools wheel\npip install -U \\\n  pre-commit coveralls pyyaml pytest-django\npip install -U -r requirements.txt\n\necho \"PATH=$PATH\" >> $GITHUB_ENV\n"
+                    "run": "uv sync --group ci --locked"
                 },
                 {
                     "name": "Copy secret.py",
                     "run": "cp intranet/settings/ci_secret.py intranet/settings/secret.py"
                 },
                 {
                     "name": "Regenerate workflow YAML file and check for changes",
-                    "run": "./scripts/build_ensure_no_changes.sh ./ci/regen-workflow.py"
+                    "run": "uv run ./scripts/build_ensure_no_changes.sh ./ci/regen-workflow.py"
                 },
                 {
                     "name": "Check for changes to CI spec",
-                    "run": "./scripts/build_ensure_no_changes.sh ./ci/regen-workflow.py"
+                    "run": "uv run ./scripts/build_ensure_no_changes.sh ./ci/regen-workflow.py"
                 },
                 {
                     "name": "Validate PR commit messages",
                     "if": "github.event_name == 'pull_request'",
-                    "run": "./scripts/validate-commit-messages.py ${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }}"
+                    "run": "uv run ./scripts/validate-commit-messages.py ${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }}"
                 },
                 {
                     "name": "Validate push commit messages",
@@ -120,7 +106,7 @@
                 },
                 {
                     "name": "Build docs",
-                    "run": "./scripts/build_ensure_no_changes.sh ./scripts/build_docs.sh"
+                    "run": "uv run ./scripts/build_ensure_no_changes.sh ./scripts/build_docs.sh"
                 },
                 {
                     "name": "Push docs",
@@ -179,23 +165,16 @@
                     "uses": "actions/checkout@v2"
                 },
                 {
-                    "name": "Set up Python ${{ matrix.python-version }}",
-                    "uses": "actions/setup-python@v2",
-                    "with": {
-                        "python-version": "${{ matrix.python-version }}"
-                    }
+                    "name": "Set up uv",
+                    "uses": "astral-sh/setup-uv@v5"
                 },
                 {
-                    "name": "Set up pip cache",
-                    "uses": "actions/cache@v2",
-                    "with": {
-                        "path": "~/.cache/pip",
-                        "key": "pip-${{ matrix.python-version }}"
-                    }
+                    "name": "Set up Python ${{ matrix.python-version }}",
+                    "run": "uv python install ${{ matrix.python-version }}"
                 },
                 {
                     "name": "Set up packages",
-                    "run": "set -e\n\npip install -U pip setuptools wheel\npip install -U \\\n  pre-commit coveralls pyyaml pytest-django\npip install -U -r requirements.txt\n\necho \"PATH=$PATH\" >> $GITHUB_ENV\n"
+                    "run": "uv sync --group ci --locked"
                 },
                 {
                     "name": "Copy secret.py",
@@ -227,24 +206,24 @@
                 {
                     "name": "Run tests (Fork)",
                     "if": "github.repository_owner != 'tjcsl'",
-                    "run": "coverage run -a ./manage.py test --noinput --parallel 4"
+                    "run": "uv run coverage run -a ./manage.py test --noinput --parallel 4"
                 },
                 {
                     "name": "Run tests (PR/Push)",
                     "if": "github.repository_owner == 'tjcsl'",
-                    "run": "coverage run -a ./manage.py test --noinput"
+                    "run": "uv run coverage run -a ./manage.py test --noinput"
                 },
                 {
                     "name": "Check for unmigrated changes",
-                    "run": "coverage run -a ./manage.py makemigrations --noinput --check"
+                    "run": "uv run coverage run -a ./manage.py makemigrations --noinput --check"
                 },
                 {
                     "name": "Migrate database",
-                    "run": "coverage run -a ./manage.py migrate"
+                    "run": "uv run coverage run -a ./manage.py migrate"
                 },
                 {
                     "name": "Collect static files",
-                    "run": "coverage run -a ./manage.py collectstatic --noinput -v 0"
+                    "run": "uv run coverage run -a ./manage.py collectstatic --noinput -v 0"
                 },
                 {
                     "name": "Report coverage to Coveralls",
@@ -256,7 +235,7 @@
                 {
                     "name": "Build coverage XML file",
                     "if": "github.repository_owner == 'tjcsl' && github.event_name != 'pull_request'",
-                    "run": "coverage xml"
+                    "run": "uv run coverage xml"
                 },
                 {
                     "name": "Report coverage to Codacy",

.pre-commit-config.yaml

@@ -16,8 +16,6 @@ repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
     hooks:
-      - id: check-ast
-        name: Validate Python
       - id: trailing-whitespace
       - id: mixed-line-ending
         args: ["--fix=lf"]

.python-version

@@ -0,0 +1 @@
+3.8

ci/spec.yml

@@ -27,12 +27,6 @@ env:
   node_versions: &node_versions
     - 12.x
 
-  python_setup: &python_setup
-    name: Set up Python ${{ matrix.python-version }}
-    uses: actions/setup-python@v2
-    with:
-      python-version: ${{ matrix.python-version }}
-
   repo_setup: &repo_setup
     name: Set up repo
     uses: actions/checkout@v2
@@ -43,24 +37,17 @@ env:
     with:
       fetch-depth: 0
 
-  setup_pip_cache: &setup_pip_cache
-    name: Set up pip cache
-    uses: actions/cache@v2
-    with:
-      path: ~/.cache/pip
-      key: pip-${{ matrix.python-version }}
+  setup_uv_cache: &setup_uv_cache
+    name: Set up uv
+    uses: astral-sh/setup-uv@v5
+
+  python_setup: &python_setup
+    name: Set up Python ${{ matrix.python-version }}
+    run: uv python install ${{ matrix.python-version }}
 
   setup_packages: &setup_packages
     name: Set up packages
-    run: |
-      set -e
-
-      pip install -U pip setuptools wheel
-      pip install -U \
-        pre-commit coveralls pyyaml pytest-django
-      pip install -U -r requirements.txt
-
-      echo "PATH=$PATH" >> $GITHUB_ENV
+    run: uv sync --group ci --locked
 
   .copy_secret: &copy_secret
     name: Copy secret.py
@@ -77,13 +64,13 @@ jobs:
 
     steps:
       - *repo_setup
+      - *setup_uv_cache
       - *python_setup
-      - *setup_pip_cache
       - *setup_packages
       - *copy_secret
 
       - name: Run pre-commit
-        run: 'pre-commit run --all-files'
+        run: 'uv run pre-commit run --all-files'
 
   build:
     runs-on: ubuntu-latest
@@ -96,31 +83,31 @@ jobs:
     steps:
       # We need the full history so we can validate commit messages.
       - *repo_setup_fetch_all
+      - *setup_uv_cache
       - *python_setup
-      - *setup_pip_cache
       - *setup_packages
       - *copy_secret
 
       - name: Regenerate workflow YAML file and check for changes
-        run: ./scripts/build_ensure_no_changes.sh ./ci/regen-workflow.py
+        run: uv run ./scripts/build_ensure_no_changes.sh ./ci/regen-workflow.py
 
       # Check for changes to CI spec
       - name: Check for changes to CI spec
-        run: ./scripts/build_ensure_no_changes.sh ./ci/regen-workflow.py
+        run: uv run ./scripts/build_ensure_no_changes.sh ./ci/regen-workflow.py
 
       # Validate commit messages
       - name: Validate PR commit messages
         # Validate commit messages for PRs
         if: "github.event_name == 'pull_request'"
-        run: ./scripts/validate-commit-messages.py ${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }}
+        run: uv run ./scripts/validate-commit-messages.py ${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }}
       - name: Validate push commit messages
         # Validate commit messages for forks and branches that aren't dev or master
         if: "github.event_name == 'push' && (github.repository_owner != 'tjcsl' || github.ref != 'refs/heads/master' || github.ref != 'refs/heads/dev')"
         run: 'git fetch origin ${{ github.event.before }} && ./scripts/validate-commit-messages.py ${{ github.event.before }}..${{ github.event.after }}'
 
       # Build/push docs
       - name: Build docs
-        run: ./scripts/build_ensure_no_changes.sh ./scripts/build_docs.sh
+        run: uv run ./scripts/build_ensure_no_changes.sh ./scripts/build_docs.sh
       - name: Push docs
         # Only run for pushes to the main Ion repo
         if: github.event_name == 'push' && github.ref == 'refs/heads/master' && github.repository_owner == 'tjcsl' && matrix.python-version == 3.8
@@ -164,8 +151,8 @@ jobs:
 
     steps:
       - *repo_setup
+      - *setup_uv_cache
       - *python_setup
-      - *setup_pip_cache
       - *setup_packages
       - *copy_secret
 
@@ -197,20 +184,21 @@ jobs:
           sudo apt update
           sudo apt install -y krb5-user
 
+
       # Tests
       - name: Run tests (Fork)
         if: github.repository_owner != 'tjcsl'
-        run: coverage run -a ./manage.py test --noinput --parallel 4
+        run: uv run coverage run -a ./manage.py test --noinput --parallel 4
       - name: Run tests (PR/Push)
         if: github.repository_owner == 'tjcsl'  # Run single-threaded for accurate coverage reporting on Ion GitHub
-        run: coverage run -a ./manage.py test --noinput
+        run: uv run coverage run -a ./manage.py test --noinput
       # Check for unmigrated changes
       - name: Check for unmigrated changes
-        run: coverage run -a ./manage.py makemigrations --noinput --check
+        run: uv run coverage run -a ./manage.py makemigrations --noinput --check
       - name: Migrate database
-        run: coverage run -a ./manage.py migrate
+        run: uv run coverage run -a ./manage.py migrate
       - name: Collect static files
-        run: coverage run -a ./manage.py collectstatic --noinput -v 0
+        run: uv run coverage run -a ./manage.py collectstatic --noinput -v 0
 
       # Coveralls
       - name: Report coverage to Coveralls
@@ -221,7 +209,7 @@ jobs:
       # Codacy
       - name: Build coverage XML file
         if: github.repository_owner == 'tjcsl' && github.event_name != 'pull_request'
-        run: coverage xml
+        run: uv run coverage xml
       - name: Report coverage to Codacy
         uses: codacy/codacy-coverage-reporter-action@master
         if: github.repository_owner == 'tjcsl' && github.event_name != 'pull_request'

config/docker/Dockerfile

@@ -1,18 +1,18 @@
 FROM python:3.8.19-alpine3.18
 
-ENV TZ America/New_York
-ENV C_FORCE_ROOT true
+ENV TZ=America/New_York
+ENV C_FORCE_ROOT=true
 
 COPY config/krb5.conf /etc/krb5.conf
-COPY requirements.txt .
-COPY requirements-dev.txt .
+COPY pyproject.toml .
+
+COPY --from=ghcr.io/astral-sh/uv:0.6 /uv /bin/uv
 
 RUN apk update && \
     apk add bash git curl build-base libpq-dev freetype-dev libffi-dev ruby-full libmagic krb5 kinit rsync nodejs npm tzdata libxml2-dev libxslt-dev && \
     npm install -g sass && \
     ln -s /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone && \
-    pip3 install -Ir requirements.txt && \
-    pip3 install -Ir requirements-dev.txt && \
-    rm requirements.txt requirements-dev.txt
+    # note that this also includes dev dependencies: pass --no-dev to exclude them
+    uv sync
 
 WORKDIR /ion

config/docker/docker-compose.yml

@@ -1,5 +1,3 @@
-version: '3.9'
-
 services:
   redis:
     container_name: intranet_redis

config/docker/entrypoint.sh

@@ -12,6 +12,6 @@ export PYTHONUNBUFFERED=1  # Don't buffer Django output
 # Wrap the run command in a loop so that it restarts if it crashes, e.g. due to a syntax error
 while true
 do
-    python3 manage.py run 0.0.0.0:8080  # Custom run command that skips system checks for performance
+    uv run manage.py run 0.0.0.0:8080  # Custom run command that skips system checks for performance
     sleep 1
 done