Skip to content

Commit 22a125c

Browse files
committed
chore: update github-release-notes skill
1 parent 68ab412 commit 22a125c

1 file changed

Lines changed: 19 additions & 4 deletions

File tree

  • .codex/skills/github-release-notes

.codex/skills/github-release-notes/SKILL.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ Generate release notes from a user-selected set of commits. Keep the output conc
1010
## Workflow
1111

1212
1. Determine the exact commits to include.
13-
2. Run `scripts/collect_commits.py` with the selected SHAs or ranges.
14-
3. Read the emitted commit list or JSON payload.
15-
4. Write release notes in this structure unless the user asks for another format:
13+
2. If the user gives a start and end commit and expects both included, convert that into an inclusive Git range before collecting commits. Prefer `start^..end` for a closed interval `[start, end]`.
14+
3. Run `scripts/collect_commits.py` with the selected SHAs or ranges.
15+
4. Read the emitted commit list or JSON payload.
16+
5. Write release notes in this structure unless the user asks for another format:
1617

1718
```md
1819
## What's Changed
@@ -44,7 +45,8 @@ python3 ~/.codex/skills/github-release-notes/scripts/collect_commits.py \
4445
Useful patterns:
4546

4647
- Pass individual SHAs to preserve a curated order.
47-
- Pass a range like `base..head` to include everything in commit order.
48+
- Pass a range like `base^..head` to include both `base` and `head` in commit order.
49+
- Use plain `base..head` only when you intentionally want an open interval that excludes `base`.
4850
- Use `--format markdown` when the full changelog bullets are all you need.
4951

5052
## Writing Rules
@@ -70,3 +72,16 @@ Useful patterns:
7072
## Example Prompt
7173

7274
`Use $github-release-notes to draft release notes from commits 2bb0481 1db7019 16258ce 9afdd2c 9b85fd8 9b6969e in the current repo.`
75+
76+
Inclusive range example:
77+
78+
`Use $github-release-notes to draft release notes from 0e01b0a623db78040ae059c0a4faa8675b06dc26 to the latest commit in the current repo.`
79+
80+
Interpret that as:
81+
82+
```bash
83+
python3 ~/.codex/skills/github-release-notes/scripts/collect_commits.py \
84+
--repo /path/to/repo \
85+
--format json \
86+
0e01b0a623db78040ae059c0a4faa8675b06dc26^..HEAD
87+
```

0 commit comments

Comments
 (0)