dev: Migrate from pip-compile to uv (#1177)

Author: ajay-sentry

.github/workflows/ci.yml

@@ -21,25 +21,26 @@ permissions:
 jobs:
   lint:
     name: Run Lint
-    uses: codecov/gha-workflows/.github/workflows/[email protected].26
+    uses: codecov/gha-workflows/.github/workflows/[email protected].33
 
   build:
     name: Build API
-    uses: codecov/gha-workflows/.github/workflows/[email protected].26
+    uses: codecov/gha-workflows/.github/workflows/[email protected].33
     secrets: inherit
     with:
       repo: ${{ vars.CODECOV_IMAGE_V2 || 'codecov/self-hosted-api' }}
+      cache_file: "uv.lock"
 
   codecovstartup:
     name: Codecov Startup
     needs: build
-    uses: codecov/gha-workflows/.github/workflows/[email protected].26
+    uses: codecov/gha-workflows/.github/workflows/[email protected].33
     secrets: inherit
 
   test:
     name: Test
     needs: [build]
-    uses: codecov/gha-workflows/.github/workflows/[email protected].30
+    uses: codecov/gha-workflows/.github/workflows/[email protected].33
     secrets: inherit
     with:
       run_integration: false
@@ -48,16 +49,17 @@ jobs:
   build-self-hosted:
     name: Build Self Hosted API
     needs: [build, test]
-    uses: codecov/gha-workflows/.github/workflows/[email protected].27
+    uses: codecov/gha-workflows/.github/workflows/[email protected].33
     secrets: inherit
     with:
       repo: ${{ vars.CODECOV_IMAGE_V2 || 'codecov/self-hosted-api' }}
+      cache_file: "uv.lock"
 
   staging:
     name: Push Staging Image
     needs: [build, test]
     if: ${{ github.event_name == 'push' && github.event.ref == 'refs/heads/staging' && github.repository_owner == 'codecov' }}
-    uses: codecov/gha-workflows/.github/workflows/[email protected].27
+    uses: codecov/gha-workflows/.github/workflows/[email protected].33
     secrets: inherit
     with:
       environment: staging
@@ -67,7 +69,7 @@ jobs:
     name: Push Production Image
     needs: [build, test]
     if: ${{ github.event_name == 'push' && github.event.ref == 'refs/heads/main' && github.repository_owner == 'codecov' }}
-    uses: codecov/gha-workflows/.github/workflows/[email protected].27
+    uses: codecov/gha-workflows/.github/workflows/[email protected].33
     secrets: inherit
     with:
       environment: production
@@ -78,7 +80,8 @@ jobs:
     needs: [build-self-hosted, test]
     secrets: inherit
     if: ${{ github.event_name == 'push' && github.event.ref == 'refs/heads/main' && github.repository_owner == 'codecov' }}
-    uses: codecov/gha-workflows/.github/workflows/[email protected].27
+    uses: codecov/gha-workflows/.github/workflows/[email protected].33
     with:
       push_rolling: true
       repo: ${{ vars.CODECOV_IMAGE_V2 || 'codecov/self-hosted-api' }}
+      cache_file: "uv.lock"

.github/workflows/mypy.yml

@@ -11,4 +11,4 @@ on:
 jobs:
   patch-typing-check:
     name: Run Patch Type Check
-    uses: codecov/gha-workflows/.github/workflows/[email protected].21
+    uses: codecov/gha-workflows/.github/workflows/[email protected].33

.github/workflows/self-hosted-release-pr.yml

@@ -10,5 +10,5 @@ on:
 jobs:
   create-release-pr:
     name: Create PR for Release ${{ github.event.inputs.versionName }}
-    uses: codecov/gha-workflows/.github/workflows/[email protected].21
+    uses: codecov/gha-workflows/.github/workflows/[email protected].33
     secrets: inherit

.github/workflows/self-hosted-release.yml

@@ -14,16 +14,17 @@ jobs:
   create-release:
     name: Tag Release ${{ github.head_ref }} and Push Docker image to Docker Hub
     if: ${{ github.event.pull_request.merged == true && startsWith(github.head_ref, 'release/') && github.repository_owner == 'codecov' }}
-    uses: codecov/gha-workflows/.github/workflows/[email protected].21
+    uses: codecov/gha-workflows/.github/workflows/[email protected].33
     with:
       tag_to_prepend: self-hosted-
     secrets: inherit
 
   push-image:
     needs: [create-release]
     if: ${{ github.event.pull_request.merged == true && startsWith(github.head_ref, 'release/') && github.repository_owner == 'codecov' }}
-    uses: codecov/gha-workflows/.github/workflows/[email protected].21
+    uses: codecov/gha-workflows/.github/workflows/[email protected].33
     secrets: inherit
     with:
       push_release: true
       repo: ${{ vars.CODECOV_IMAGE_V2 || 'codecov/self-hosted-api' }}
+      cache_file: "uv.lock"

.pre-commit-config.yaml

@@ -1,16 +1,16 @@
 repos:
-- repo: local
-  hooks:
-  - id: lint
-    name: lint
-    description: "Lint and sort"
-    entry: make lint.run
-    pass_filenames: false
-    require_serial: true
-    language: system
-- repo: https://github.com/pre-commit/mirrors-mypy
-  rev: 'v1.10.0'
-  hooks:
-  - id: mypy
-    verbose: true
-    entry: bash -c 'mypy "$@" || true' --
+  - repo: local
+    hooks:
+      - id: lint
+        name: lint
+        description: "Lint and sort"
+        entry: make lint.local
+        pass_filenames: false
+        require_serial: true
+        language: system
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: "v1.10.0"
+    hooks:
+      - id: mypy
+        verbose: true
+        entry: bash -c 'mypy "$@" || true' --

Makefile

@@ -7,7 +7,7 @@ branch = $(shell git branch | grep \* | cut -f2 -d' ')
 epoch := $(shell date +"%s")
 AR_REPO ?= codecov/api
 DOCKERHUB_REPO ?= codecov/self-hosted-api
-REQUIREMENTS_TAG := requirements-v1-$(shell sha1sum requirements.txt | cut -d ' ' -f 1)-$(shell sha1sum docker/Dockerfile.requirements | cut -d ' ' -f 1)
+REQUIREMENTS_TAG := requirements-v1-$(shell sha1sum uv.lock | cut -d ' ' -f 1)-$(shell sha1sum docker/Dockerfile.requirements | cut -d ' ' -f 1)
 VERSION := release-${sha}
 CODECOV_UPLOAD_TOKEN ?= "notset"
 CODECOV_STATIC_TOKEN ?= "notset"
@@ -20,7 +20,7 @@ API_DOMAIN ?= api
 PROXY_NETWORK ?= api_default
 
 # Codecov CLI version to use
-CODECOV_CLI_VERSION := 0.5.1
+CODECOV_CLI_VERSION := 9.0.4
 
 build:
 	make build.requirements
@@ -30,20 +30,20 @@ check-for-migration-conflicts:
 	python manage.py check_for_migration_conflicts
 
 test:
-	COVERAGE_CORE=sysmon python -m pytest --cov=./ --junitxml=junit.xml -o junit_family=legacy
+	COVERAGE_CORE=sysmon pytest --cov=./ --junitxml=junit.xml -o junit_family=legacy
 
 test.unit:
 	@if [ -n "$(GROUP)" ]; then \
-		COVERAGE_CORE=sysmon python -m pytest --splits ${SPLIT} --group $(GROUP) --cov=./ -m "not integration" --cov-report=xml:unit.$(GROUP).coverage.xml --junitxml=unit.$(GROUP).junit.xml -o junit_family=legacy; \
+		COVERAGE_CORE=sysmon pytest --splits ${SPLIT} --group $(GROUP) --cov=./ -m "not integration" --cov-report=xml:unit.$(GROUP).coverage.xml --junitxml=unit.$(GROUP).junit.xml -o junit_family=legacy; \
 	else \
-		COVERAGE_CORE=sysmon python -m pytest --cov=./ -m "not integration" --cov-report=xml:unit.coverage.xml --junitxml=unit.junit.xml -o junit_family=legacy; \
+		COVERAGE_CORE=sysmon pytest --cov=./ -m "not integration" --cov-report=xml:unit.coverage.xml --junitxml=unit.junit.xml -o junit_family=legacy; \
 	fi
 
 test.integration:
 	@if [ -n "$(GROUP)" ]; then \
-		COVERAGE_CORE=sysmon python -m pytest --splits ${SPLIT} --group $(GROUP) --cov=./ -m "integration" --cov-report=xml:integration.$(GROUP).coverage.xml --junitxml=integration.$(GROUP).junit.xml -o junit_family=legacy; \
+		COVERAGE_CORE=sysmon pytest --splits ${SPLIT} --group $(GROUP) --cov=./ -m "integration" --cov-report=xml:integration.$(GROUP).coverage.xml --junitxml=integration.$(GROUP).junit.xml -o junit_family=legacy; \
 	else \
-		COVERAGE_CORE=sysmon python -m pytest --cov=./ -m "integration" --cov-report=xml:integration.coverage.xml --junitxml=integration.junit.xml -o junit_family=legacy; \
+		COVERAGE_CORE=sysmon pytest --cov=./ -m "integration" --cov-report=xml:integration.coverage.xml --junitxml=integration.junit.xml -o junit_family=legacy; \
 	fi
 
 lint:
@@ -54,6 +54,14 @@ lint.install:
 	echo "Installing..."
 	pip install -Iv ruff
 
+lint.local:
+	make lint.install.local
+	make lint.run
+
+lint.install.local:
+	echo "Installing..."
+	uv add --dev ruff
+
 lint.run:
 	ruff check
 	ruff format
@@ -186,17 +194,17 @@ push.self-hosted-rolling:
 	docker push ${DOCKERHUB_REPO}:rolling
 
 shell:
-	docker-compose exec api bash
+	docker compose exec api bash
 
 test_env.up:
 	env | grep GITHUB > .testenv; true
 	docker-compose up -d
 
 test_env.prepare:
-	docker-compose exec api make test_env.container_prepare
+	docker compose exec api make test_env.container_prepare
 
 test_env.check_db:
-	docker-compose exec api make test_env.container_check_db
+	docker compose exec api make test_env.container_check_db
 	make test_env.check-for-migration-conflicts
 
 test_env.install_cli:
@@ -212,21 +220,21 @@ test_env.container_check_db:
 
 test_env.run_unit:
 	@if [ -n "$(GROUP)" ]; then \
-		docker-compose exec api make test.unit SPLIT=${SPLIT} GROUP=${GROUP}; \
+		docker compose exec api make test.unit SPLIT=${SPLIT} GROUP=${GROUP}; \
 	else \
-		docker-compose exec api make test.unit; \
+		docker compose exec api make test.unit; \
 	fi
 
 test_env.run_integration:
 	# @if [ -n "$(GROUP)" ]; then \
-	# 	docker-compose exec api make test.integration SPLIT=${SPLIT} GROUP=${GROUP}; \
+	# 	docker compose exec api make test.integration SPLIT=${SPLIT} GROUP=${GROUP}; \
 	# else \
-	# 	docker-compose exec api make test.integration; \
+	# 	docker compose exec api make test.integration; \
 	# fi
 	echo "Skipping. No Tests"
 
 test_env.check-for-migration-conflicts:
-	docker-compose exec api python manage.py check_for_migration_conflicts
+	docker compose exec api python manage.py check_for_migration_conflicts
 
 test_env:
 	make test_env.up

README.md

@@ -1,11 +1,10 @@
-Codecov API
------------
+## Codecov API
 
 > We believe that everyone should have access to quality software (like Sentry), that’s why we have always offered Codecov for free to open source maintainers.
 >
 > By making our code public, we’re not only joining the community that’s supported us from the start — but also want to make sure that every developer can contribute to and build on the Codecov experience.
 
-A private Django REST Framework API intended to serve Codecov's front end. 
+A private Django REST Framework API intended to serve Codecov's front end.
 
 ## Getting Started
 
@@ -21,7 +20,7 @@ Note, you'll need to install Rust to build `ribs` which is a dependency of `shar
 
 ### Running Standalone
 
-This project contains a `docker-compose.yml` file that is intended to run the api standalone. In this configuration it **does not** share codecov.io's development database; so don't expect parity there. 
+This project contains a `docker-compose.yml` file that is intended to run the api standalone. In this configuration it **does not** share codecov.io's development database; so don't expect parity there.
 
 To start the service, do
 
@@ -33,7 +32,7 @@ Once running, the api will be available at `http://localhost:5100`
 
 ### Running with codecov.io
 
-This service will startup when you run codecov.io normally. It is under that `api` block of codecov.io's `docker-compose.yml` file. 
+This service will startup when you run codecov.io normally. It is under that `api` block of codecov.io's `docker-compose.yml` file.
 
 ### Testing
 
@@ -48,7 +47,7 @@ If you would like to use pytest directly (Either through an IDE like PyCharm or
 
     RUN_ENV=TESTING DJANGO_SETTINGS_MODULE=codecov.settings_test pytest
 
-Make sure to have all the requirements from `requirements.txt` installed.
+Make sure to have all the latest dependencies installed via `uv sync`.
 
 ### Deploying
 
@@ -69,23 +68,18 @@ Steps 2 and 3 are important to limit interaction between features not yet merged
 This project should store no secrets or credentials in its source. If you need to add to / modify / setup secrets for this project, contact Eli and he'll get you started..
 
 ### Adding dependencies
-This repository uses `pip-tools` to manage dependencies, so make sure you've installed it with `pip install pip-tools`. To add or update dependencies, change `requirements.in`,  Then run
 
-```
-pip-compile requirements.in
-```
-
-Do not change `requirements.txt` directly.
+This repository uses `uv` to manage dependencies, so make sure you've installed it with `pip install uv`. To add or update dependencies, simply run `uv add __package_name__` or `uv sync`.
 
 ### Formatting
 
-This project uses `ruff` for formatting.      
-You can run the linter using the command `make lint`.
+This project uses `ruff` for formatting.  
+You can run the linter using the command `make lint_local`.
 
 ### Migrations
 
 We leverage Django's migration system to keep the state of our models in sync with the state of our database. You can read more about how we work with migrations at https://codecovio.atlassian.net/wiki/spaces/ENG/pages/1696530442/Migrations
 
 ## Contributing
 
-This repository, like all of Codecov's repositories, strives to follow our general [Contributing guidlines](https://github.com/codecov/contributing). If you're considering making a contribution to this repository, we encourage review of our Contributing guidelines first. 
+This repository, like all of Codecov's repositories, strives to follow our general [Contributing guidlines](https://github.com/codecov/contributing). If you're considering making a contribution to this repository, we encourage review of our Contributing guidelines first.

dev.sh

@@ -23,7 +23,8 @@ _start_gunicorn() {
     python manage.py insert_data_to_db_from_csv core/management/commands/codecovPlans-Jan25.csv --model plans
   fi
   if [[ "$DEBUGPY" ]]; then
-      pip install debugpy
+      uv add debugpy
+      uv sync
       python -m debugpy --listen 0.0.0.0:12345 -m gunicorn codecov.wsgi:application --reload --bind 0.0.0.0:8000 --access-logfile '-' --timeout "${GUNICORN_TIMEOUT:-600}" $suffix
   fi
   gunicorn codecov.wsgi:application --reload --bind 0.0.0.0:8000 --access-logfile '-' --timeout "${GUNICORN_TIMEOUT:-600}" $suffix

docker/Dockerfile

@@ -6,10 +6,10 @@ ARG BERGLAS_VERSION=2.0.6
 FROM us-docker.pkg.dev/berglas/berglas/berglas:$BERGLAS_VERSION as berglas
 
 FROM $REQUIREMENTS_IMAGE as app
-COPY . /app/apps/codecov-api
+
 WORKDIR /app/apps/codecov-api
-RUN pip install setuptools==71.1.0
-RUN python manage.py collectstatic --no-input
+ADD . /app/apps/codecov-api
+
 
 FROM app as local
 
@@ -20,7 +20,6 @@ COPY --chmod=755 --from=berglas /bin/berglas /usr/local/bin/berglas
 
 FROM app as self-hosted
 
-RUN pip uninstall -y typing
 # set settings module
 ENV DJANGO_SETTINGS_MODULE="codecov.settings_enterprise"
 # Remove the settings dev and enterprise files.