Add cross-repo release checklist for experiment promotion#26
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a formal cross-repo promotion gate and release checklist to manage the transition of experiment findings from the experiment repository into Comptextv7. It adds docs/CROSS_REPO_RELEASE_CHECKLIST.md and updates existing documentation to define the promotion lifecycle, required artifacts, and validation commands. Reviewer feedback focuses on correcting inconsistent file naming for contract validation reports and improving auditability by requiring that validation results be included in pull requests and agent instructions.
| - `docs/reports/benchmark-summary.json` | ||
| - `docs/reports/regression-summary.json` | ||
| - `docs/reports/sanitization-summary.json` | ||
| - `docs/reports/report-contract-validation-report.md` |
There was a problem hiding this comment.
The filename report-contract-validation-report.md appears to be a typo or inconsistent with the naming convention used in scripts/validate_contracts.py and elsewhere in the documentation (e.g., line 180). It should likely be contract-validation-report.md for consistency.
| - `docs/reports/report-contract-validation-report.md` | |
| - `docs/reports/contract-validation-report.md` |
| - `docs/reports/benchmark-summary.json` | ||
| - `docs/reports/regression-summary.json` | ||
| - `docs/reports/sanitization-summary.json` | ||
| - `docs/reports/report-contract-validation-report.md` |
There was a problem hiding this comment.
The filename report-contract-validation-report.md appears to be inconsistent with the output of scripts/validate_contracts.py. Using contract-validation-report.md ensures consistency across the documentation and the validation scripts.
| - `docs/reports/report-contract-validation-report.md` | |
| - `docs/reports/contract-validation-report.md` |
| - [ ] Required Comptextv7 validation commands are run or explicitly documented as | ||
| not required because of a safe environment limitation. |
There was a problem hiding this comment.
To ensure auditability and alignment with the instructions in docs/AGENT_WORKFLOW.md (which mentions including validation results in the PR), the checklist should explicitly state that the generated reports should be included in the pull request.
| - [ ] Required Comptextv7 validation commands are run or explicitly documented as | |
| not required because of a safe environment limitation. | |
| - [ ] Required Comptextv7 validation commands are run and their reports are included | |
| in the PR, or explicitly documented as not required because of a safe | |
| environment limitation. |
| 2. Apply the go/no-go criteria before changing Comptextv7. | ||
| 3. Create a Comptextv7 issue when ownership, safety, or release impact is unclear. | ||
| 4. Keep promotion PRs narrow and avoid unrelated refactors. | ||
| 5. Run the required Comptextv7 validation commands for implementation PRs. |
There was a problem hiding this comment.
Updating the agent instructions to explicitly mention including the generated reports will help maintain the audit trail required for release decisions.
| 5. Run the required Comptextv7 validation commands for implementation PRs. | |
| 5. Run the required Comptextv7 validation commands for implementation PRs and include the generated reports. |
| benchmark_summary: docs/reports/benchmark-summary.json | ||
| regression_summary: docs/reports/regression-summary.json | ||
| sanitization_summary: docs/reports/sanitization-summary.json | ||
| contract_validation: docs/reports/report-contract-validation-report.md |
There was a problem hiding this comment.
Correcting the filename in the example record to match the standard naming convention used in the repository scripts.
| contract_validation: docs/reports/report-contract-validation-report.md | |
| contract_validation: docs/reports/contract-validation-report.md |
1 participant
Motivation
Description
docs/CROSS_REPO_RELEASE_CHECKLIST.mdcontaining Purpose, Repository roles, Promotion lifecycle, Required experiment artifacts, Required Comptextv7 checks, Go/no-go criteria, No-go criteria, Rollback criteria, Security checklist, PR checklist, Agent instructions, and an example synthetic promotion record.docs/AGENT_WORKFLOW.mdto reference the cross-repo checklist and instruct Codex/Gemini agents to apply it after experiment validation and before creating Comptextv7 implementation PRs.docs/BENCHMARK_INTEGRATION.mdto reference the promotion gate, enumerate the required experiment artifacts, the required Comptextv7 validation commands, and the go/no-go decision flow.Testing
python scripts/repo_intake.pyand it produced the repository intake report successfully.python scripts/run_checks.pyand it completed writing the local check report successfully.python scripts/validate_contracts.pyand it reported contract validation passed and wrote the contract validation report.python scripts/generate_contract_fixtures.pyandpython scripts/validate_api_exports.pywhich generated synthetic fixtures and validated API/export artifacts successfully.Links issue #25.
Codex Task