Skip to content

Commit 8766503

Browse files
zdrapeladurandom
authored andcommitted
docs: add ruamel.yaml PEP 723 exception to ADR 0002
Document that prow skill scripts use ruamel.yaml via PEP 723 inline script metadata for round-trip YAML fidelity. The dependency is managed by uv run --script with no user-facing install step. Addresses non-blocking review item from PR #25. Assisted-by: OpenCode
1 parent 04e365a commit 8766503

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

docs/adr/0002-stdlib-only-python-clis.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,9 @@ Both CLIs (`rhdh` and `rhdh-local`) use only Python 3.9+ standard library — ze
99
- **`uv`** as the dev tool runner (`uv run pytest`) — not shipped with the CLIs, but used for development and testing
1010

1111
New scripts and CLI commands in this project should follow these same patterns.
12+
13+
## Exceptions
14+
15+
Prow skill scripts (under `skills/prow/scripts/`) use `ruamel.yaml` for round-trip YAML processing — preserving comments, key ordering, and quoting style that the stdlib `yaml` module cannot handle. These scripts declare the dependency via PEP 723 inline script metadata (`# /// script` blocks), and `uv run --script` auto-installs it in an ephemeral virtual environment. No user-facing install step is required.
16+
17+
The stdlib-only rule still applies to the main CLIs and any script not run via `uv run --script`.

0 commit comments

Comments
 (0)