Skip to content

Commit f3f69c2

Browse files
committed
docs: clarify final-release-review target selection
1 parent dd0de62 commit f3f69c2

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

  • .codex/skills/final-release-review

.codex/skills/final-release-review/SKILL.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
name: final-release-review
3-
description: Perform a release-readiness review by locating the previous release tag from remote tags and auditing the diff (e.g., v1.2.3...main) for breaking changes, regressions, improvement opportunities, and risks before releasing openai-agents-python.
3+
description: Perform a release-readiness review by locating the previous release tag from remote tags and auditing the diff (e.g., v1.2.3...<commit>) for breaking changes, regressions, improvement opportunities, and risks before releasing openai-agents-python.
44
---
55

66
# Final Release Review
77

88
## Purpose
99

10-
Use this skill when validating main for release. It guides you to fetch remote tags, pick the previous release tag, and thoroughly inspect the `BASE_TAG...TARGET` diff for breaking changes, introduced bugs/regressions, improvement opportunities, and release risks.
10+
Use this skill when validating the latest release candidate commit (default tip of `origin/main`) for release. It guides you to fetch remote tags, pick the previous release tag, and thoroughly inspect the `BASE_TAG...TARGET` diff for breaking changes, introduced bugs/regressions, improvement opportunities, and release risks.
1111

1212
## Quick start
1313

@@ -16,7 +16,7 @@ Use this skill when validating main for release. It guides you to fetch remote t
1616
```bash
1717
BASE_TAG="$(.codex/skills/final-release-review/scripts/find_latest_release_tag.sh origin 'v*')"
1818
```
19-
3. Choose target (default `main`, ensure fresh): `git fetch origin main --prune` then `TARGET="main"`.
19+
3. Choose target commit (default tip of `origin/main`, ensure fresh): `git fetch origin main --prune` then `TARGET="$(git rev-parse origin/main)"`.
2020
4. Snapshot scope:
2121
```bash
2222
git diff --stat "${BASE_TAG}"..."${TARGET}"
@@ -34,7 +34,7 @@ Use this skill when validating main for release. It guides you to fetch remote t
3434
- If the user specifies a base tag, prefer it but still fetch remote tags first.
3535
- Keep the working tree clean to avoid diff noise.
3636
- **Assumptions**
37-
- Assume `main` has already passed `$code-change-verification` in CI unless the user says otherwise.
37+
- Assume the target commit (default `origin/main` tip) has already passed `$code-change-verification` in CI unless the user says otherwise.
3838
- Do not block a release solely because you did not run tests locally; focus on concrete behavioral or API risks.
3939
- **Map the diff**
4040
- Use `--stat`, `--dirstat`, and `--name-status` outputs to spot hot directories and file types.
@@ -63,7 +63,7 @@ This is a release readiness report done by `$final-release-review` skill.
6363
6464
### Diff
6565
66-
https://github.com/openai/openai-agents-python/compare/<tag>...main
66+
https://github.com/openai/openai-agents-python/compare/<tag>...<target-commit>
6767
6868
### Release call:
6969
- <GREEN LIGHT TO SHIP | BLOCKED> <one-line rationale>

0 commit comments

Comments
 (0)