Centralize regen tool pins in pyproject.toml regen group

Author: splch

.github/workflows/generated.yml

@@ -19,17 +19,18 @@ jobs:
         with:
           persist-credentials: false
       - uses: ./.github/actions/setup-uv
+      - run: uv sync --group regen
       - name: Prepare spec
         run: |
           set -euo pipefail
           if [[ -f openapi-overlay.yaml ]]; then
-            uvx oas-patch==0.6.0 overlay openapi.json openapi-overlay.yaml -o /tmp/patched-spec.json
+            uv run oas-patch overlay openapi.json openapi-overlay.yaml -o /tmp/patched-spec.json
           else
             cp openapi.json /tmp/patched-spec.json
           fi
       - name: Regenerate client
         run: |
-          uvx openapi-python-client==0.28.3 generate \
+          uv run openapi-python-client generate \
             --path /tmp/patched-spec.json \
             --meta none \
             --config openapi-python-client-config.yaml \

AGENTS.md

@@ -54,16 +54,17 @@ When you hit a bug in generated code:
 Run exactly what's in [`CONTRIBUTING.md`](CONTRIBUTING.md) and mirrored in [`.github/workflows/generated.yml`](.github/workflows/generated.yml):
 
 ```sh
+uv sync --group regen
 curl -sf https://api.ionq.co/v0.4/api-docs -o openapi.json
-uvx oas-patch==0.6.0 overlay openapi.json openapi-overlay.yaml -o /tmp/patched-spec.json
-uvx openapi-python-client==0.28.3 generate \
+uv run oas-patch overlay openapi.json openapi-overlay.yaml -o /tmp/patched-spec.json
+uv run openapi-python-client generate \
   --path /tmp/patched-spec.json --meta none \
   --config openapi-python-client-config.yaml \
   --custom-template-path custom-templates \
   --output-path ionq_core --overwrite
 ```
 
-Both pinned versions appear in `CONTRIBUTING.md` *and* `.github/workflows/generated.yml`; `tests/test_docs_consistency.py` fails CI if you bump one without the other. Commit regenerated files in the same PR as the spec/template/overlay change that produced them.
+Commit regenerated files in the same PR as the spec/template/overlay change that produced them.
 
 ## Calling generated endpoints
 

CONTRIBUTING.md

@@ -62,15 +62,16 @@ CI runs them on a weekly schedule via the [`integration`](.github/workflows/inte
 To regenerate `ionq_core/api/`, `ionq_core/models/`, and the root-level generated files, run:
 
 ```sh
+uv sync --group regen
 curl -sf https://api.ionq.co/v0.4/api-docs -o openapi.json
 
 if [ -f openapi-overlay.yaml ]; then
-    uvx oas-patch==0.6.0 overlay openapi.json openapi-overlay.yaml -o /tmp/patched-spec.json
+    uv run oas-patch overlay openapi.json openapi-overlay.yaml -o /tmp/patched-spec.json
 else
     cp openapi.json /tmp/patched-spec.json
 fi
 
-uvx openapi-python-client==0.28.3 generate \
+uv run openapi-python-client generate \
     --path /tmp/patched-spec.json \
     --meta none \
     --config openapi-python-client-config.yaml \

pyproject.toml

@@ -45,6 +45,10 @@ dev = [
     "ty",
     "pdoc>=16",
 ]
+regen = [
+    "oas-patch==0.6.0",
+    "openapi-python-client==0.28.3",
+]
 
 [build-system]
 requires = ["hatchling"]

tests/test_docs_consistency.py

@@ -19,8 +19,6 @@
 GITATTRIBUTES = (ROOT / ".gitattributes").read_text()
 CONTRIB = (ROOT / "CONTRIBUTING.md").read_text()
 AGENTS = (ROOT / "AGENTS.md").read_text()
-GENERATED_WF = (ROOT / ".github" / "workflows" / "generated.yml").read_text()
-SPEC_DRIFT_WF = (ROOT / ".github" / "workflows" / "spec-drift.yml").read_text()
 
 
 def _normalize(path: str) -> str:
@@ -44,12 +42,6 @@ def _ci_python_versions() -> list[str]:
     return re.findall(r'"(\d+\.\d+)"', m.group(1))
 
 
-def _pin(text: str, package: str) -> str:
-    m = re.search(rf"{re.escape(package)}==(\S+)", text)
-    assert m, f"{package} pin not found"
-    return m.group(1)
-
-
 @pytest.mark.parametrize(
     "needle",
     [
@@ -119,14 +111,6 @@ def test_gitattributes_covers_ruff_paths_plus_init():
     assert gitattr == ruff | {"ionq_core/__init__.py"}
 
 
-def test_openapi_python_client_versions_match():
-    assert _pin(CONTRIB, "openapi-python-client") == _pin(GENERATED_WF, "openapi-python-client")
-
-
-def test_oas_patch_versions_match():
-    assert _pin(CONTRIB, "oas-patch") == _pin(GENERATED_WF, "oas-patch")
-
-
 def test_spec_path_matches_default_base_url():
     # Without this, a DEFAULT_BASE_URL bump leaves CONTRIBUTING.md pointing at a stale endpoint.
     spec_path = f"{urlparse(DEFAULT_BASE_URL).path}/api-docs"
@@ -150,12 +134,6 @@ def test_single_spdx_year_across_package():
     assert len(years) == 1, f"expected exactly one SPDX year, found: {years}"
 
 
-@pytest.mark.parametrize("package", ["openapi-python-client", "oas-patch"])
-def test_generator_pin_in_agents_md(package):
-    """Pinned versions in the AGENTS.md regen block match CONTRIBUTING.md."""
-    assert _pin(AGENTS, package) == _pin(CONTRIB, package), f"{package} pin in AGENTS.md does not match CONTRIBUTING.md"
-
-
 def test_spec_path_in_agents_md():
     """The api-docs path quoted in AGENTS.md tracks DEFAULT_BASE_URL."""
     spec_path = f"{urlparse(DEFAULT_BASE_URL).path}/api-docs"