main
md 32 lines 1.19 KB
Rendered Raw
1 # Scripts DOX
2
3 ## Purpose
4
5 - Own maintainer and automation scripts that live outside GitHub workflow directories.
6 - Keep scripts deterministic, documented by nearby callers, and safe to run in clean checkouts.
7
8 ## Ownership
9
10 - `openrouter_release_notes_system_prompt.md` is consumed by `.github/scripts/docker_release_plan.py`.
11 - Additional repository maintenance scripts belong here when they are not runtime application code.
12
13 ## Local Contracts
14
15 - Do not commit secrets, generated credentials, private release notes, or local machine paths.
16 - Scripts used by CI must have stable inputs and fail with actionable errors.
17 - Keep script behavior synchronized with `.github/AGENTS.md`, workflow YAML, and tests.
18
19 ## Work Guidance
20
21 - Prefer standard library Python or simple shell-compatible assets unless a dependency already exists for the script's runtime.
22 - Keep prompts and automation inputs concise and version-controlled.
23 - Update callers when renaming or moving scripts.
24
25 ## Verification
26
27 - Run targeted tests for any automation script with coverage.
28 - For release-note prompt changes, inspect generated output format expectations in `.github/scripts/docker_release_plan.py`.
29
30 ## Child DOX Index
31
32 No child DOX files.