Skip to content

Commit a4bd646

Browse files
committed
PR_26175_OWNER_047 require Codex ZIP for all runs
1 parent c562301 commit a4bd646

6 files changed

Lines changed: 297 additions & 641 deletions

File tree

docs_build/dev/PROJECT_INSTRUCTIONS.md

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -784,12 +784,13 @@ The full samples smoke test rule remains separate and runs only when broadly imp
784784

785785
## CODEX REVIEW DIFF REQUIREMENT
786786

787-
Every Codex PR must produce review artifacts so ChatGPT can review the exact code changes.
787+
Every completed Codex PR or completed Codex run must produce review artifacts so ChatGPT can review the exact repo changes or the no-change evidence.
788788

789789
Codex must create:
790790

791791
- `docs_build/dev/reports/codex_review.diff`
792792
- `docs_build/dev/reports/codex_changed_files.txt`
793+
- a PR-specific or EOD-specific report under `docs_build/dev/reports/`
793794

794795
`codex_review.diff` must contain:
795796
- `git diff --cached`
@@ -804,6 +805,9 @@ Rules:
804805
- Do not pause commits
805806
- Do not add dependencies
806807
- Do not change runtime behavior just to create review artifacts
808+
- Required reports remain required even when a ZIP is created.
809+
- Required report evidence must include branch validation PASS/FAIL, a requirement-by-requirement PASS/FAIL checklist, a validation lane report, and manual validation notes.
810+
- A ZIP artifact must not replace or move required report files out of `docs_build/dev/reports/`.
807811

808812
When user asks for code review, they should upload:
809813
- PR delta ZIP
@@ -812,7 +816,7 @@ When user asks for code review, they should upload:
812816

813817
## MANUAL TEST REQUIREMENT
814818

815-
Every PR must include:
819+
Every completed PR, audit, report-only, validation-only, or EOD closeout run must include:
816820
- exact manual validation steps
817821
- expected outcome
818822
- any known out-of-scope checks
@@ -870,8 +874,15 @@ Codex ZIPs must:
870874
- be repo-structured
871875
- preserve exact repo-relative paths
872876
- be placed under `<project folder>/tmp/`
873-
- use the PR name in the ZIP filename
877+
- use the PR or EOD run name in the ZIP filename
874878
- contain no extra files outside the defined structure
879+
- include all changed or preserved repo files from the completed run
880+
- not include or depend on generated loose files under `tmp/`
881+
- not replace required report files under `docs_build/dev/reports/`
882+
883+
If a completed run changes no repo files, Codex must still create a ZIP containing the PR or EOD report that proves no repo files changed.
884+
885+
The no-change ZIP rule does not apply when the run hard-stopped before producing outputs.
875886

876887
Before Codex returns any ZIP, Codex must:
877888
1. Physically create the ZIP file.
@@ -1584,11 +1595,21 @@ Required reports:
15841595

15851596
## REQUIRED ZIP OUTPUT
15861597

1587-
Codex must ALWAYS produce a repo-structured ZIP for every PR.
1598+
Codex must ALWAYS produce a repo-structured ZIP for every completed Codex run.
1599+
1600+
This applies to:
1601+
- implementation PRs
1602+
- audit PRs
1603+
- report-only PRs
1604+
- validation-only PRs
1605+
- EOD closeout runs
1606+
- governance and cleanup runs
15881607

15891608
The ZIP must follow the existing CODEX ZIP STANDARD.
15901609

1591-
The ZIP is required output, not optional.
1610+
The ZIP must include all changed or preserved repo files from the run.
1611+
1612+
The ZIP is required output, not optional, and it does not replace required reports under `docs_build/dev/reports/`.
15921613

15931614
## HTML FILE RESTRICTIONS
15941615

@@ -1823,10 +1844,12 @@ Do NOT require:
18231844

18241845
## CODEX ZIP RETURN CONTRACT
18251846

1826-
Codex must include the repo-structured ZIP in returned artifacts for user and ChatGPT review.
1847+
Codex must include the repo-structured ZIP path in returned artifacts for user and ChatGPT review for every completed run.
18271848

18281849
The ZIP must still follow the CODEX ZIP STANDARD.
18291850

1851+
If no repo files changed, the returned ZIP must contain the PR or EOD report proving the no-change result unless the run hard-stopped before outputs were produced.
1852+
18301853
## CODE REVIEW EVIDENCE RULE
18311854

18321855
ChatGPT must not claim code review was completed unless it inspected uploaded source, ZIP contents, or `codex_review.diff`.
@@ -2044,6 +2067,7 @@ Required steps:
20442067
- local/origin sync = 0 0
20452068
5. Record final main commit.
20462069
6. Report final repository state.
2070+
7. Produce the required repo-structured ZIP under `tmp/` containing the EOD report and any changed or preserved repo files from the closeout.
20472071

20482072
Required final state:
20492073

@@ -2235,6 +2259,9 @@ Completion hard stops:
22352259
- If required reports are missing, HARD STOP.
22362260
- If `docs_build/dev/reports/codex_review.diff` is missing, HARD STOP.
22372261
- If `docs_build/dev/reports/codex_changed_files.txt` is missing, HARD STOP.
2262+
- If branch validation PASS/FAIL is missing, HARD STOP.
2263+
- If the requirement-by-requirement PASS/FAIL checklist is missing, HARD STOP.
2264+
- If the validation lane report is missing, HARD STOP.
22382265
- If manual validation notes are missing, HARD STOP.
22392266
- If the PR-specific report is missing, HARD STOP.
22402267
- If an instruction compliance checklist is required and missing, HARD STOP.

docs_build/dev/ProjectInstructions/addendums/multi_team.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,7 @@ Required gate:
121121
- blocked PRs with blockers
122122
- next review queue
123123
- final branch/worktree/local-origin sync
124+
- repo-structured ZIP path under `tmp/`
124125

125126
OWNER_049 lesson:
126127
- PRs #129, #132, and #134 were merge-approved and still required merge execution.
@@ -148,6 +149,7 @@ Required steps:
148149
- local/origin sync = 0 0
149150
5. Record final main commit.
150151
6. Report final repository state.
152+
7. Produce a repo-structured ZIP under `tmp/` that includes the EOD report and all changed or preserved repo files from the closeout.
151153

152154
Required final state:
153155

@@ -165,6 +167,8 @@ Rules:
165167
- A workstream is not considered closed until the repository is returned to main.
166168
- A PI is not considered complete until main is current and synchronized.
167169
- Do not leave Codex on a feature, team, workstream, recovery, governance, or owner branch after successful merge.
170+
- A completed EOD closeout must produce the required ZIP even when the closeout changed no repo files; in that case, the ZIP must contain the EOD report proving the no-change result.
171+
- The EOD ZIP does not replace the EOD report or other required reports under `docs_build/dev/reports/`.
168172
- If merge succeeds but repository is not returned to main:
169173
closeout status = FAIL.
170174

docs_build/dev/ProjectInstructions/addendums/pr_workflow.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ Define the standard pull request workflow for Game Foundry Studio.
3434
- If validation fails, stop and report.
3535
- If conflict occurs, stop and report.
3636
- If OWNER decision is required, stop and report.
37+
- Every completed Codex PR run must produce a repo-structured ZIP under `tmp/`.
38+
- The ZIP rule applies to implementation, audit, report-only, validation-only, governance, and cleanup PRs.
39+
- The ZIP must include all changed or preserved repo files from the run and must not replace required reports under `docs_build/dev/reports/`.
40+
- If no repo files changed, Codex must still create a ZIP containing the PR report that proves the no-change result, unless the run hard-stopped before producing outputs.
3741

3842
## Batch Governance Mode
3943

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# PR_26175_OWNER_047 Codex ZIP Required For All Runs
2+
3+
## Summary
4+
This governance-only PR clarifies that every completed Codex run must produce a repo-structured ZIP under `tmp/`, including implementation PRs, audit PRs, report-only PRs, validation-only PRs, governance/cleanup runs, and EOD closeouts.
5+
6+
No runtime code changed.
7+
8+
## Located Governance Files
9+
| File | Role | Change |
10+
| --- | --- | --- |
11+
| `docs_build/dev/PROJECT_INSTRUCTIONS.md` | Authoritative root project instructions for Codex outputs, report requirements, ZIP standard, PR completion, and EOD hard stops. | Updated |
12+
| `docs_build/dev/ProjectInstructions/addendums/pr_workflow.md` | PR workflow addendum for standard PR execution rules. | Updated |
13+
| `docs_build/dev/ProjectInstructions/addendums/multi_team.md` | Multi-team and EOD closeout addendum. | Updated |
14+
| `docs_build/dev/ProjectInstructions/PROJECT_INSTRUCTIONS.md` | Index for the append-first Project Instructions operating system. | Reviewed; no output rules to update |
15+
| `docs_build/dev/ProjectInstructions/TEAM_START_COMMANDS.md` | Team start and EOD reminder text. | Reviewed; no output rules to update |
16+
17+
## Requirement Checklist
18+
| Requirement | Result | Evidence |
19+
| --- | --- | --- |
20+
| Use main branch only | PASS | Branch validation confirmed current branch is `main`. |
21+
| Scope governance docs only | PASS | Changed files are governance docs and required reports only. |
22+
| No runtime code changes | PASS | No `src/`, `assets/`, `toolbox/`, or test runtime files changed. |
23+
| Locate active governance files | PASS | Active output rules found in root instructions, PR workflow addendum, and EOD multi-team addendum. |
24+
| Require ZIP for every completed Codex run | PASS | Root instructions now require ZIPs for every completed Codex run. |
25+
| Cover implementation, audit, report-only, validation-only, and EOD runs | PASS | Root instructions and PR/EOD addendums list those run types. |
26+
| ZIP includes changed/preserved repo files | PASS | Root ZIP standard and PR/EOD addendums require inclusion of all changed or preserved repo files. |
27+
| ZIP does not replace reports | PASS | Root instructions and addendums state ZIPs do not replace `docs_build/dev/reports/` files. |
28+
| Existing reports remain required | PASS | Root report rules explicitly preserve `codex_review.diff`, `codex_changed_files.txt`, PR/EOD report, branch validation, requirement checklist, validation lane report, and manual validation notes. |
29+
| No-change runs still produce ZIP | PASS | Root instructions and PR/EOD addendums require a ZIP containing the PR/EOD no-change report unless the run hard-stopped before outputs. |
30+
| Required reports created | PASS | This report, `codex_review.diff`, and `codex_changed_files.txt` were created/updated. |
31+
| Repo-structured ZIP under `tmp/` | PASS | ZIP created at `tmp/PR_26175_OWNER_047-codex-zip-required-for-all-runs_delta.zip`. |
32+
33+
## Branch Validation
34+
| Check | Result | Evidence |
35+
| --- | --- | --- |
36+
| Current branch is `main` | PASS | `git branch --show-current` returned `main`. |
37+
| Branch validation recorded | PASS | This section records PASS/FAIL branch evidence. |
38+
39+
## Validation Lane Report
40+
| Lane | Result | Evidence |
41+
| --- | --- | --- |
42+
| Docs-only validation | PASS | Changed paths are limited to `docs_build/dev/` governance and report files. |
43+
| Playwright impacted | PASS | No; governance docs only. |
44+
| Runtime validation | PASS | Not applicable; no runtime files changed. |
45+
46+
## Manual Validation Notes
47+
| Step | Result | Notes |
48+
| --- | --- | --- |
49+
| Reviewed root output rules | PASS | Confirmed required report and ZIP sections remain present and now apply to all completed Codex runs. |
50+
| Reviewed PR workflow addendum | PASS | Confirmed completed PR runs require `tmp/` ZIP output. |
51+
| Reviewed EOD addendum | PASS | Confirmed EOD reports must include ZIP path and closeouts must produce a ZIP. |
52+
| Verified report preservation rule | PASS | ZIP language states reports remain required under `docs_build/dev/reports/`. |
53+
54+
## Changed Files
55+
| File | Purpose |
56+
| --- | --- |
57+
| `docs_build/dev/PROJECT_INSTRUCTIONS.md` | Clarifies required reports and universal completed-run ZIP output. |
58+
| `docs_build/dev/ProjectInstructions/addendums/pr_workflow.md` | Adds PR workflow ZIP output rule for completed Codex PR runs. |
59+
| `docs_build/dev/ProjectInstructions/addendums/multi_team.md` | Adds EOD ZIP path/report expectations and closeout ZIP rule. |
60+
| `docs_build/dev/reports/PR_26175_OWNER_047-codex-zip-required-for-all-runs.md` | PR-specific report with branch validation, checklist, validation lane, and manual notes. |
61+
| `docs_build/dev/reports/codex_review.diff` | Required review diff artifact. |
62+
| `docs_build/dev/reports/codex_changed_files.txt` | Required changed-files artifact. |
63+
64+
## ZIP
65+
| Artifact | Result |
66+
| --- | --- |
67+
| `tmp/PR_26175_OWNER_047-codex-zip-required-for-all-runs_delta.zip` | PASS - repo-structured ZIP containing changed repo files from this run. |
Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,22 @@
1-
docs_build/dev/BUILD_PR.md
2-
assets/theme-v2/js/toolbox-status-bar.js
3-
assets/theme-v2/css/status.css
4-
tests/playwright/tools/ToolboxSelectedGameStatusBar.spec.mjs
5-
docs_build/dev/reports/PR_26175_ALFA_011-status-bar-journey-progress-context_report.md
6-
docs_build/dev/reports/PR_26175_ALFA_011-status-bar-journey-progress-context_validation-lane.md
7-
docs_build/dev/reports/PR_26175_ALFA_011-status-bar-journey-progress-context_requirements-checklist.md
8-
docs_build/dev/reports/codex_review.diff
9-
docs_build/dev/reports/codex_changed_files.txt
1+
# git status --short
2+
M docs_build/dev/PROJECT_INSTRUCTIONS.md
3+
M docs_build/dev/ProjectInstructions/addendums/multi_team.md
4+
M docs_build/dev/ProjectInstructions/addendums/pr_workflow.md
5+
A docs_build/dev/reports/PR_26175_OWNER_047-codex-zip-required-for-all-runs.md
6+
M docs_build/dev/reports/codex_changed_files.txt
7+
M docs_build/dev/reports/codex_review.diff
8+
9+
# git ls-files --others --exclude-standard
10+
11+
12+
# git diff --stat
13+
14+
15+
# git diff --cached --stat
16+
docs_build/dev/PROJECT_INSTRUCTIONS.md | 39 +-
17+
.../ProjectInstructions/addendums/multi_team.md | 4 +
18+
.../ProjectInstructions/addendums/pr_workflow.md | 4 +
19+
...75_OWNER_047-codex-zip-required-for-all-runs.md | 67 ++
20+
docs_build/dev/reports/codex_changed_files.txt | 27 +-
21+
docs_build/dev/reports/codex_review.diff | 818 +++++----------------
22+
6 files changed, 307 insertions(+), 652 deletions(-)

0 commit comments

Comments
 (0)