feat(dev): devenv + uv + pre-commit #5070

joshuarli · 2025-08-19T23:45:51Z

This introduces devenv, uv and pre-commit in accordance with these repo standards:
https://www.notion.so/sentry/Standard-Spec-devenv-2238b10e4b5d8072a992d8b67d94be22
https://www.notion.so/sentry/Standard-Spec-python-uv-2248b10e4b5d8045b8fff30f8b8b67ca
https://www.notion.so/sentry/Standard-Spec-pre-commit-2238b10e4b5d8019aa1fe1158e39c38e

The ability to run devenv sync and get a dev environment in any repo is the DX i'm aiming for,
and these standards provide a foundation from which later we can easily push updates to all repos.

You should be able to checkout this branch, run direnv allow and devenv sync (might be prompted to run ~/.local/share/sentry-devenv/bin/devenv update first), which will set up everything needed for development (other than cargo).

Thanks to uv and our internal pypi, setting up the venv is near instant now (excluding the rust build of py/ of course).

Originally I was going to split this into 2 PRs, where the latter would configure py/ for uv, but it's not very good DX since uv sync will erase it as it doesn't know about it.

Note

Introduce devenv + uv for Python envs and pre-commit hooks, update CI to use uv/venv with targeted linting, and replace legacy venv/requirements workflow across repo.

Developer Environment:
- Add devenv/ (config and sync.py), Brewfile, root pyproject.toml, py/pyproject.toml, uv.lock, and .pre-commit-config.yaml to standardize setup with uv and pre-commit.
- Replace .envrc to load .env, add uv/devenv to PATH, and require devenv; export .venv.
- Add setup.cfg for flake8; remove requirements-dev.txt and scripts/git-precommit-hook.
CI/CD:
- Migrate workflows to uv: replace actions/setup-python with astral-sh/setup-uv + getsentry/action-setup-venv; install deps via uv sync.
- In ci.yml, add changed-file detection and run pre-commit on modified files; cache pre-commit; adjust Python build/test to use uv; update devservices validation to read version from uv.lock.
- In build_library.yml, trigger on PR, use uv-based venv for macOS and sdist builds; comment out artifact merge step.
Makefile & Docs:
- Simplify Makefile: drop Python style/lint/format targets and legacy venv management; setup-venv now runs devenv sync and installs py/ via uv.
- Update README.md to use devenv sync and uv pip commands.

^{Written by Cursor Bugbot for commit ab5c3b7. This will update automatically on new commits. Configure here.}

joshuarli · 2025-08-21T23:19:39Z

.pre-commit-config.yaml

+    # TODO: reactivate when fixed
+    # - id: check-github-workflows
+
+-   repo: local


pre-commit now runs in ci and now runs black/flake8/mypy (locked+installed via uv) on python files!

joshuarli · 2025-08-21T23:21:42Z

Makefile


 # Style checking

-style: style-rust style-python ## check code style


style and lint for python's moved into pre-commit

i decided to leave rust alone for now to keep things simple (will need some work as tools like rustfmt and clippy-driver are needed to accept individual file arguments)

joshuarli · 2025-08-21T23:31:39Z

Makefile

-	$$RELAY_PYTHON_VERSION -m venv --copies .venv
-	.venv/bin/pip install -U pip wheel
-
-.venv/python-requirements-stamp: requirements-dev.txt


rerunning make setup-venv will always make sure python stuff is up to date and reexecutes the build - all this complexity can be removed

joshuarli · 2025-08-21T23:32:06Z

Makefile

-	# Make will re-run 'pip install' if the mtime on requirements-dev.txt is higher again.
-	touch .venv/python-requirements-stamp
-
-.git/hooks/pre-commit:


this has been rolled up into pre-commit install --install-hooks in devenv sync

joshuarli · 2025-08-21T23:35:00Z

.envrc

-#!/bin/bash
+#!/not/executable/bash

 # Our policy is that the .envrc is entirely optional, and a user


devenv/sync.py and .pre-commit-config.yaml are all using .venv/bin explicitly so this policy you have here is still being respected! although you will need a global install of devenv: https://github.com/getsentry/devenv/?tab=readme-ov-file#install

(chances are and i would hope relay devs already have devenv installed as it is required for sentry development)

actually well it is needed to put .devenv/bin on path so you have access to devenv's uv at .devenv/bin/uv

loewenheim

LGTM but I would appreciate a second opinion

loewenheim · 2025-08-27T08:44:08Z

.pre-commit-config.yaml

    hooks:
    - id: check-github-actions
-    - id: check-github-workflows
+    # TODO: reactivate when fixed


What is this referring to? What needs to be fixed?

https://gist.github.com/joshuarli/36587aeb18445bf18f36abcd4b82382e
(upgraded to 0.33.0 since in previous versions output is a lot less readable)

mostly complaining about 'uses' is a required property which... it is not? lol

jjbayer · 2025-08-29T06:40:11Z

.github/workflows/build_library.yml

Were you able to test this workflow? Any chance we will face surprises next time we want to release the library?

Ah good catch, I'll run it and see!

yup it's totally broken haha, will fix

README.md

…ight

cursor · 2025-10-04T00:15:17Z

devenv/sync.py

+        )
+
+    if not shutil.which("rustup"):
+        raise SystemExit("rustup not on PATH. Did you run `direnv allow`?")


Bug: Rustup Check Fails During Fresh Setup

The rustup check runs too early in the sync script. Although brew bundle installs rustup earlier, it's not immediately available on PATH until the environment (like direnv) reloads. This causes the script to exit prematurely on a fresh setup with a misleading error.

joshuarli added 4 commits August 19, 2025 16:44

first pass

fc348b4

ignore some and fix some

a70f01c

repin

5d556eb

fix

5f8b910

joshuarli changed the title ~~feat: devenv and pre-commit~~ feat: devenv + uv + pre-commit Aug 20, 2025

joshuarli added 8 commits August 19, 2025 17:25

add py as workspace

b16ecd7

.

73fb625

incrementally run pre-commit

8c99e1f

pc

047f166

regenerate lockfile

8d5db14

[skip ci] reduce reliance on direnv for first runs

cfbc3ec

[skip ci] fixes

1dc7bb6

devenv should not build

bb87254

joshuarli commented Aug 21, 2025

View reviewed changes

simplify make setup-venv

6388fec

joshuarli commented Aug 21, 2025

View reviewed changes

joshuarli marked this pull request as ready for review August 21, 2025 23:36

joshuarli requested a review from a team as a code owner August 21, 2025 23:36

This comment was marked as outdated.

Sign in to view

hubertdeng123 added the skip-changelog label Aug 27, 2025

loewenheim approved these changes Aug 27, 2025

View reviewed changes

joshuarli added 2 commits August 28, 2025 16:44

install rustup via brew and add rustfmt to pre-commit

8ffdff4

librdkafka and update readme

320b3f8

jjbayer reviewed Aug 29, 2025

View reviewed changes

exercise build_library

67826ad

This comment was marked as outdated.

Sign in to view

[skip ci] add note

74ff9cd

Merge branch 'master' into devenv-and-pre-commit

be53798

This comment was marked as outdated.

Sign in to view

fix: uv is already aware of plat

38369f3

joshuarli force-pushed the devenv-and-pre-commit branch from 8625a9c to 38369f3 Compare September 4, 2025 21:57

This comment was marked as outdated.

Sign in to view

joshuarli added 3 commits September 4, 2025 16:38

add wheel and revert to using python setup.py, uv build doesnt seem r…

55e3b65

…ight

revert to using legacy setup.py for milksnake

ee67f9c

Merge remote-tracking branch 'origin' into devenv-and-pre-commit

2781325

joshuarli changed the title ~~feat: devenv + uv + pre-commit~~ feat(dev): devenv + uv + pre-commit Sep 29, 2025

This comment was marked as outdated.

Sign in to view

joshuarli added 3 commits September 29, 2025 15:58

add build deps

f40e886

convince setuptools its ok to use milksnake

2914803

misc fixes

ab5c3b7

This comment was marked as outdated.

Sign in to view

joshuarli added 2 commits October 3, 2025 17:09

Merge branch 'master' into devenv-and-pre-commit

41febe5

relay-conventions/sentry-conventions 7a3f6a296fc6

a8b829b

cursor bot reviewed Oct 4, 2025

View reviewed changes


		# Style checking

		style: style-rust style-python ## check code style

feat(dev): devenv + uv + pre-commit #5070

Are you sure you want to change the base?

feat(dev): devenv + uv + pre-commit #5070

Uh oh!

Conversation

joshuarli commented Aug 19, 2025 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

loewenheim left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

cursor bot Oct 4, 2025

Choose a reason for hiding this comment

Bug: Rustup Check Fails During Fresh Setup

Uh oh!

Uh oh!

joshuarli commented Aug 19, 2025 •

edited by cursor bot

Loading