Skip to content

Commit db52126

Browse files
docs: document the 5.1 smoke lever for contributors
Place the how-to in CONTRIBUTING.md, where version targeting already lives, and point at it from the workflow header, README, AGENTS.md, and the PR template. Signed-off-by: TMHSDigital <154358121+TMHSDigital@users.noreply.github.com> Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent b6c9228 commit db52126

5 files changed

Lines changed: 21 additions & 5 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Label every claim.
1717
- **live-run-proven:** exact binary path + the version that binary printed (`blender --version`). Headless harness only. Live MCP does not count.
1818
- **inspection-only:** read the skill / diff / RNA docs; no process ran.
1919

20-
`blender-smoke.yml` has no `push` trigger. Post-merge smoke evidence is the PR-head 5.2 + 4.5 jobs (state the versions from those logs).
20+
`blender-smoke.yml` has no `push` trigger. Post-merge smoke evidence is the PR-head 5.2 + 4.5 jobs (state the versions from those logs). Apply `needs-5.1` when 5.1 must be CI-proven on the PR; default matrix does not include it.
2121

2222
## Release-owned fields — do not hand-edit
2323

AGENTS.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,10 @@ way, and a one-paragraph rationale. 30 to 80 lines is the right size.
157157
the manifest `version` line (see `release.yml` below) — never hand-edit it.
158158
- `blender-smoke.yml` executes every shipped example (check-only, no render)
159159
plus snippet/template smoke tests inside REAL headless Blender, on
160-
5.2 LTS and 4.5 LTS for every PR (5.1 on the weekly cron). Examples run
160+
5.2 LTS and 4.5 LTS for every PR. 5.1 is weekly cron, the opt-in
161+
`needs-5.1` PR label (`pull_request` types include `labeled`), or
162+
`workflow_dispatch` with a `series` input. Auto-label does not apply
163+
`needs-5.1`. Contributor-facing notes live in CONTRIBUTING.md. Examples run
161164
through `tests/smoke/run_example.py` (catalog: `tests/smoke/catalog.json`).
162165
SKIP is exit 77 plus a `SMOKE_SKIP:` reason, and only when `--min-version`
163166
is above this Blender; exit 0 with that marker is a vacuous pass and fails.

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ AI asset pipeline track: `decimate_to_budget.py`, `convex_hull_collider.py`, `lo
102102

103103
Runnable scripts at `examples/<name>/`, each asserting a real API contract with
104104
deterministic checks (exit non-zero on failure) and optionally rendering a still via
105-
`--output`. All of them run headless on Blender 5.2 LTS and 4.5 LTS in `blender-smoke.yml` (5.1 on the weekly cron);
105+
`--output`. All of them run headless on Blender 5.2 LTS and 4.5 LTS in `blender-smoke.yml` (5.1 on the weekly cron, the `needs-5.1` PR label, or manual dispatch);
106106
their renders ship in the site gallery at `docs/gallery/`. `examples/gallery.json` is the
107107
gallery's source of truth. When authoring a new one, copy the anatomy of
108108
`examples/bmesh-gear/` (script structure, README shape, dark-studio render recipe) and

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,19 @@ else:
9999
...
100100
```
101101

102+
## Blender smoke on pull requests
103+
104+
Default PR smoke is Blender 5.2 and 4.5 (`.github/workflows/blender-smoke.yml`).
105+
5.1 is not in that matrix.
106+
107+
- Apply the `needs-5.1` label when the change can diverge on 5.1 (bake, UV
108+
RNA, version-branched API). That starts a 5.1 smoke job. Auto-label will
109+
not apply this; it is opt-in.
110+
- Run any series on demand: Actions > Blender Smoke Test > Run workflow,
111+
pick the branch and the `series` input.
112+
- Monday 07:00 UTC cron still runs 5.2, 5.1, and 4.5. Do not treat cron as
113+
PR evidence.
114+
102115
## Standards-version Markers
103116

104117
Files that participate in ecosystem drift checking must carry a `standards-version` marker matching the current meta-repo `STANDARDS_VERSION` (which is decoupled from this repo's `VERSION`):

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,13 @@ blender --background --python examples/bmesh-gear/bmesh_gear.py --
6666
| Version | Status |
6767
| --- | --- |
6868
| Blender 5.2 LTS | Primary target (current stable; all examples assume 5.2 unless a 4.5 path is shown) |
69-
| Blender 5.1 | Prior stable (weekly smoke only) |
69+
| Blender 5.1 | Prior stable (weekly cron; PR via `needs-5.1` or manual dispatch) |
7070
| Blender 4.5 LTS | Fallback supported (skills show both code paths where 4.x and 5.x APIs diverge) |
7171

7272
## Examples
7373

7474
Runnable, smoke-gated demos live in [`examples/`](examples/) — each is executed headless on
75-
Blender 5.2 LTS and 4.5 LTS by the `blender-smoke` workflow (5.1 on the weekly cron), so the screenshots reflect code
75+
Blender 5.2 LTS and 4.5 LTS by the `blender-smoke` workflow (5.1 on the weekly cron, the `needs-5.1` PR label, or manual dispatch), so the screenshots reflect code
7676
that actually runs. Browse them all with filters and full-size renders in the
7777
**[examples gallery](https://tmhsdigital.github.io/Blender-Developer-Tools/gallery/)**,
7878
or expand a category below.

0 commit comments

Comments
 (0)