You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit f31bdb4
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: dev/build/ProjectInstructions/addendums/codex_artifact_and_reporting_standard.md
+63-12Lines changed: 63 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,68 @@
4
4
5
5
Standardize Codex deliverables, completion reporting, and artifact generation.
6
6
7
-
## ZIP Artifact Requirement
7
+
## Codex Completion Contract
8
8
9
-
Every Codex execution must produce a repo-structured ZIP artifact and the required reports.
9
+
Every Codex execution must produce at least one repository-structured ZIP artifact and the required reports.
10
10
11
-
This applies regardless of result:
11
+
Each PR attempted by Codex must produce exactly one ZIP artifact representing that PR's final outcome.
12
+
13
+
Missing ZIP means the Codex run did not complete correctly.
14
+
15
+
Canonical ZIP location:
16
+
17
+
```text
18
+
dev/workspace/zips/
19
+
```
20
+
21
+
ZIP outcome suffixes:
22
+
23
+
-`_delta.zip` = success
24
+
-`_REVIEW.zip` = review-only
25
+
-`_FAILED.zip` = validation or execution failure
26
+
-`_HARD_STOP.zip` = governance or precondition hard stop
27
+
28
+
## Stacked PR Rule
29
+
30
+
Stacked PR work produces one ZIP per attempted PR.
31
+
32
+
If PR 1 succeeds and PR 2 hard-stops, produce:
33
+
34
+
```text
35
+
PR_...001-..._delta.zip
36
+
PR_...002-..._HARD_STOP.zip
37
+
```
38
+
39
+
Do not start later stacked PRs after a failure or hard stop.
40
+
41
+
## ZIP Contents
42
+
43
+
Success ZIP contents must include:
44
+
45
+
- changed files
46
+
- diff
47
+
- PR report
48
+
- validation report
49
+
- requirement checklist
50
+
51
+
Failing PR ZIP contents must include:
52
+
53
+
- hard stop or failure report
54
+
- branch/worktree status
55
+
- validation output if run
56
+
- requirement checklist
57
+
- changed files and diff if changes occurred
58
+
59
+
Review-only ZIP contents must include:
60
+
61
+
- review report
62
+
- branch/worktree status
63
+
- requirement checklist or review checklist when applicable
64
+
- supporting evidence files when applicable
65
+
66
+
## Applicability
67
+
68
+
The Codex Completion Contract applies regardless of result:
12
69
13
70
- success
14
71
- completion
@@ -23,17 +80,11 @@ This applies regardless of result:
23
80
24
81
No exceptions.
25
82
26
-
Minimum ZIP contents:
83
+
Minimum repository-structured ZIP rules:
27
84
28
-
- changedor preserved repo files from the run, stored at repo-relative paths
85
+
- changed, preserved, or outcome evidence repo files from the run, stored at repo-relative paths
29
86
- required reports under `dev/reports/`
30
87
31
-
ZIP artifacts must be written under:
32
-
33
-
```text
34
-
dev/workspace/zips/
35
-
```
36
-
37
88
Reports must remain flat under `dev/reports/`. Use descriptive filenames that include the PR, team, runner, or lane context instead of nested team or runner report folders.
38
89
39
90
Optional:
@@ -107,6 +158,6 @@ unless explicitly requested.
107
158
108
159
## No ZIP Means Incomplete
109
160
110
-
A task is not considered complete until the ZIP artifact is generated and reported.
161
+
A task is not considered complete until the required ZIP artifact or artifacts are generated and reported.
111
162
112
163
If execution stops before implementation, validation, or commit, the stop result must still include the repo-structured ZIP and reports that document the hard stop, blocker, validation failure, or no-change result.
This file owns PR lifecycle governance. It must not duplicate command phase rules.
15
19
16
20
## Standard Flow
@@ -112,11 +116,9 @@ Closed gates:
112
116
- If validation fails, stop and report.
113
117
- If conflict occurs, stop and report.
114
118
- If OWNER decision is required, stop and report.
115
-
- Every Codex execution must produce a repo-structured ZIP under `dev/workspace/zips/`.
116
-
- The ZIP rule applies to implementation, audit, report-only, validation-only, governance, cleanup, hard-stop, blocked, validation-failure, partial-completion, new-information, and no-change runs.
117
-
- The ZIP must include all changed or preserved repo files from the run and must not replace required reports under `dev/reports/`.
118
-
- If no repo files changed, Codex must still create a ZIP containing the report that proves the no-change, hard-stop, blocked, validation-failure, or partial-completion result.
119
-
- No exceptions.
119
+
- Every PR lifecycle state must satisfy the Codex Completion Contract when Codex executes work for that state.
120
+
- ZIP artifacts belong under `dev/workspace/zips/` and must not replace required reports under `dev/reports/`.
121
+
- Stacked PR chains produce one final outcome ZIP per attempted PR and stop before later PRs after failure or hard stop.
Copy file name to clipboardExpand all lines: dev/build/ProjectInstructions/bootstrap/codex_start_of_day_bootstrap.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,6 +35,8 @@ The bootstrap loads:
35
35
36
36
The bootstrap must not create branches, commit files, move files, or run implementation work by itself.
37
37
38
+
Start-of-Day bootstrap must satisfy the Codex Completion Contract in `dev/build/ProjectInstructions/addendums/codex_artifact_and_reporting_standard.md` with a review-only ZIP unless a hard stop occurs.
39
+
38
40
## Wrapper Responsibilities
39
41
40
42
The wrapper performs:
@@ -87,7 +89,7 @@ If a chat instruction conflicts with Project Instructions:
87
89
88
90
- Stop.
89
91
- Do not continue the PR.
90
-
- Produce the required ZIP artifact when the active artifact rules require one.
92
+
- Produce the required ZIP artifact according to the Codex Completion Contract.
91
93
- Document the conflict in the run summary or PR report.
Copy file name to clipboardExpand all lines: dev/build/ProjectInstructions/standards/CODEX_WORKFLOW_COMMANDS.md
+5-2Lines changed: 5 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,6 +50,8 @@ Start of Day reports:
50
50
51
51
Start of Day may recommend the next execution phase, but it must not execute that phase.
52
52
53
+
Start of Day must satisfy the Codex Completion Contract in `dev/build/ProjectInstructions/addendums/codex_artifact_and_reporting_standard.md`. Because Start of Day is read-only discovery, its ZIP outcome is review-only unless another outcome is explicitly documented.
54
+
53
55
## Execution Phases
54
56
55
57
PLAN_PR, BUILD_PR, and APPLY_PR are Codex PR execution phases after Start of Day. They are not part of Start of Day.
@@ -84,6 +86,7 @@ Rules:
84
86
- Identify the correct branch or start point.
85
87
- Identify the intended PR name, purpose, and scope.
86
88
- Identify required validation and reporting.
89
+
- Identify the required ZIP outcome path from the Codex Completion Contract.
87
90
- HARD STOP on unclear scope.
88
91
- HARD STOP if Project Instructions conflict with the requested plan.
89
92
@@ -96,7 +99,7 @@ Rules:
96
99
- Use the latest Project Instructions.
97
100
- Stay inside the approved PR purpose.
98
101
- Create required reports.
99
-
- Create the required repo-structured ZIP artifact when the active artifact rules require one.
102
+
- Create the required repo-structured ZIP artifact for the attempted PR according to the Codex Completion Contract.
100
103
- Run scoped validation required by the PR and Project Instructions.
101
104
- HARD STOP on wrong branch.
102
105
- HARD STOP on dirty worktree when the PR requires a clean start.
@@ -111,7 +114,7 @@ APPLY_PR is the merge and closeout phase.
111
114
Rules:
112
115
- Verify CI status, validation status, and mergeability before merge.
113
116
- Verify the PR merge state is clean.
114
-
- Verify required reports and ZIP artifacts exist.
117
+
- Verify required reports and Codex Completion Contract ZIP artifacts exist.
115
118
- Merge only when Project Instructions and OWNER direction allow the merge.
116
119
- Update local `main` after merge.
117
120
- Report final branch, worktree status, local/origin sync status, final commit, and blockers.
0 commit comments