skilldrop-cli 0.16.14 → 0.16.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/packs/dev-team/loops/release/LOOP.md +2 -2
- package/packs/dev-team/loops/release/loop.json +1 -1
- package/packs/dev-team/skills/release-notes/SKILL.md +72 -45
- package/packs/dev-team/skills/release-notes/evals/evals.json +33 -5
- package/packs/dev-team/skills/release-notes/evals/files/6/git-log.txt +136 -0
- package/packs/dev-team/skills/release-notes/manifest.json +3 -3
- package/packs/dev-team/skills/release-notes/templates/release-notes.md +0 -83
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "skilldrop-cli",
|
|
3
|
-
"version": "0.16.
|
|
3
|
+
"version": "0.16.15",
|
|
4
4
|
"description": "Portable AI-agent skills, measured against the agent without them. ADRs, PRDs, runbooks, decks and reviews, installable into Claude Code, Cursor, Kiro, and any IDE that takes custom instructions. One command per skill or per role-based pack.",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Sanjay Ananthanarayan",
|
|
@@ -29,8 +29,8 @@ being folded into either neighbour.
|
|
|
29
29
|
checks rollback, detection, response, measured targets, data and privacy, comms and
|
|
30
30
|
exposure, each with evidence. `REVISE` returns to `plan`, and the report names which gap to
|
|
31
31
|
close and which skill closes it. A missing rollback is `BLOCKED` on its own.
|
|
32
|
-
3. **Announce only once it is ready.** `release-notes` drafts the
|
|
33
|
-
|
|
32
|
+
3. **Announce only once it is ready.** `release-notes` drafts the notes for each audience
|
|
33
|
+
you name from the git range, with nothing the log doesn't say. Writing them before G3 risks announcing a launch that
|
|
34
34
|
then does not happen.
|
|
35
35
|
4. **A human decides at G3.1.** The release owner decides whether to ship *now*, given
|
|
36
36
|
timing, freeze windows and on-call coverage. When that decision is contested, use
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$comment": "RFC-0031. Covers the step between build (ends at merge, G2.1) and operate (starts at instrument). Its gates are G3 and G3.1: the whole number places the loop in the lifecycle (discover G0 through operate G4), and a decimal is a second gate inside the same loop (RFC-0044).",
|
|
3
3
|
"name": "release",
|
|
4
|
-
"version": "0.3.
|
|
4
|
+
"version": "0.3.1",
|
|
5
5
|
"description": "Take merged code to live users through a planned, reversible rollout — plan the phases and the rollback, judge readiness on evidence, draft the release notes, then a human makes the go/no-go call. Use when the user has merged a change and asks how to roll it out, whether they are ready to launch, or for a go/no-go decision.",
|
|
6
6
|
"entrypoint": "LOOP.md",
|
|
7
7
|
"kind": "loop",
|
|
@@ -1,69 +1,96 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: release-notes
|
|
3
|
-
description:
|
|
3
|
+
description: Write release notes from a git log, a list of merged PRs or rough notes about what changed — for the audience and in the format the user names (a customer changelog page, an email, an in-app "what's new", store text, a CHANGELOG.md entry). Says nothing the input doesn't, writes a vague change only as far as it was described, puts breaking changes and anything the reader must do first, and keeps internal noise and working notes out of the text. Use when the user wants release notes, a changelog entry, "what's in this release", a deploy announcement, or to summarise changes since the last tag.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# release-notes
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
**The rule: nothing goes in the notes that the log or the user didn't say.** A release note is
|
|
9
|
+
read as a promise. The agent's habit is to make a vague commit sound finished: "tweaked onboarding"
|
|
10
|
+
becomes "onboarding is now simpler", a half-remembered fix gets a symptom, a reverted feature
|
|
11
|
+
gets announced because its commit is in the range. Each of those reads exactly like a real
|
|
12
|
+
change, and a customer will hold you to it. This skill's job is to write only what the input
|
|
13
|
+
supports, as far as it supports it.
|
|
9
14
|
|
|
10
15
|
## How to respond
|
|
11
16
|
|
|
12
|
-
**
|
|
13
|
-
|
|
14
|
-
-
|
|
15
|
-
|
|
16
|
-
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
17
|
+
1. **Find out what actually shipped.** Read the whole range or list before writing a line.
|
|
18
|
+
- A change that was reverted later in the same range did not ship. Leave it out.
|
|
19
|
+
- A later commit can narrow or contradict an earlier one ("partial fix", a figure revised,
|
|
20
|
+
a date moved). Write the final state, not the first claim.
|
|
21
|
+
- Where you have a repo and no list, take the range from the last tag to HEAD
|
|
22
|
+
(`git describe --tags --abbrev=0`, then `git log <tag>..HEAD --no-merges`). Read a commit's
|
|
23
|
+
body or diff only when its subject is too vague to tell what it does.
|
|
24
|
+
|
|
25
|
+
2. **Find what breaks or needs action, wherever it is said.** A breaking change is often not
|
|
26
|
+
marked: a removed option in a PR description, a renamed setting in a commit body, an old
|
|
27
|
+
endpoint "no longer accepted". Each one goes first, with the step the reader has to take,
|
|
28
|
+
written for how this audience gets the release. Customers of a hosted service upgrade
|
|
29
|
+
nothing; they need to know what stops working and what to do instead. A library's users
|
|
30
|
+
need the version and the migration.
|
|
31
|
+
|
|
32
|
+
3. **Write only as far as each change was described.** "Fixed a bug in exports" stays that
|
|
33
|
+
vague if that's all the input says. Don't add a symptom, a cause, a number, a date, a
|
|
34
|
+
version, a PR number or a count the input doesn't give. A change you can't tell the meaning
|
|
35
|
+
of stays out of the notes and goes in the short list in step 6.
|
|
36
|
+
|
|
37
|
+
4. **Write for this reader, in this format.** Use the channel, length and tone the user asked
|
|
38
|
+
for: a customer changelog page, an email, a pop-up of a few lines, store text with a
|
|
39
|
+
character limit, or the repo's own CHANGELOG style if there is one. Say what the reader can
|
|
40
|
+
now do or no longer suffers ✅ *"Exports with more than 10,000 rows no longer fail"*, not
|
|
41
|
+
what the code does ❌ *"fix NPE in ReportExporter.flush()"*. Use the product name only if
|
|
42
|
+
you were given it.
|
|
43
|
+
|
|
44
|
+
5. **Leave internal work out of anything a customer reads.** CI, refactors, tests, dependency
|
|
45
|
+
bumps, typo fixes and tooling are not news, not even as "various improvements". In an
|
|
46
|
+
internal changelog they may appear if the repo's existing style includes them.
|
|
47
|
+
|
|
48
|
+
6. **Hand back the notes, then at most a few lines for the user.** The notes are clean: no
|
|
49
|
+
commit range, commit count, hashes, "flagged by" notes, or review lists inside them unless
|
|
50
|
+
the user's format asks for hashes (an internal CHANGELOG often does). After the notes, list
|
|
51
|
+
once, briefly, what you left out and why: changes too vague to describe, claims the log
|
|
52
|
+
contradicts, anything the user should confirm before publishing.
|
|
53
|
+
|
|
54
|
+
7. **Deliver from what you have.** With a log, a list or notes, write the notes and state any
|
|
55
|
+
assumption about audience or format in one line. Ask first only when there is nothing to
|
|
56
|
+
work from.
|
|
38
57
|
|
|
39
58
|
## Quality bar
|
|
40
59
|
|
|
41
|
-
- **
|
|
42
|
-
|
|
43
|
-
- **
|
|
44
|
-
- **
|
|
45
|
-
|
|
46
|
-
- **
|
|
60
|
+
- **Nothing in the notes goes beyond the input.** No invented feature, behaviour, symptom,
|
|
61
|
+
figure, date, version, PR number or count.
|
|
62
|
+
- **Reverted and superseded changes don't appear;** the final state does.
|
|
63
|
+
- **Breaking changes and required actions come first,** found from the text as well as the
|
|
64
|
+
markers, with an action that fits how the audience gets the release.
|
|
65
|
+
- **Internal noise is absent from customer text.**
|
|
66
|
+
- **The format, length and tone are the ones the user asked for,** and the notes carry no
|
|
67
|
+
working notes.
|
|
68
|
+
- **Vague items are left out or kept vague, and named once to the user.**
|
|
47
69
|
|
|
48
70
|
## When to use this skill
|
|
49
71
|
|
|
50
72
|
- ✅ Cutting a release and writing "what's new" for users or customers
|
|
51
|
-
- ✅
|
|
52
|
-
- ✅ A deploy
|
|
53
|
-
- ✅ "
|
|
73
|
+
- ✅ A `CHANGELOG.md` entry between versions
|
|
74
|
+
- ✅ A deploy or release announcement for internal stakeholders
|
|
75
|
+
- ✅ "Summarise everything merged since the last tag"
|
|
54
76
|
|
|
55
77
|
## When NOT to use this skill
|
|
56
78
|
|
|
57
79
|
- ❌ A single PR description — that's one change; use `pr-description-writer`
|
|
58
80
|
- ❌ Reviewing the changes for quality or risk — that's `devils-advocate` / `sonar-review`
|
|
59
|
-
- ❌
|
|
60
|
-
- ❌
|
|
81
|
+
- ❌ A narrative about *why* the release matters strategically — feed the notes to `exec-summary`
|
|
82
|
+
- ❌ Writing commit messages going forward — this skill reads history, it doesn't write it
|
|
61
83
|
|
|
62
84
|
## Anti-patterns to avoid
|
|
63
85
|
|
|
64
|
-
- ❌ **
|
|
65
|
-
|
|
66
|
-
- ❌ **
|
|
67
|
-
- ❌ **
|
|
68
|
-
- ❌ **
|
|
69
|
-
- ❌ **
|
|
86
|
+
- ❌ **Finishing a vague change.** "Looked at the search thing" becomes "search is faster".
|
|
87
|
+
Keep it as vague as it was, or leave it out and say so.
|
|
88
|
+
- ❌ **Announcing reverted work.** A commit in the range is not a change that shipped.
|
|
89
|
+
- ❌ **Burying a quiet break.** No `!:` marker doesn't mean nothing broke; read the bodies.
|
|
90
|
+
- ❌ **"Various bug fixes and improvements."** Either a fix is worth a line or it's internal.
|
|
91
|
+
- ❌ **The working notes in the text.** Ranges, counts, hashes, "flagged by", a "Needs review"
|
|
92
|
+
table in a customer email.
|
|
93
|
+
- ❌ **A changelog where an email was asked for.** Headings and bullets in a two-paragraph
|
|
94
|
+
member update.
|
|
95
|
+
- ❌ **Marketing adjectives.** "Blazing-fast", "completely redesigned": state the measured
|
|
96
|
+
change the input gives, or nothing.
|
|
@@ -5,12 +5,12 @@
|
|
|
5
5
|
"id": 1,
|
|
6
6
|
"prompt": "Write release notes for v2.4.0 from this log (range v2.3.0..HEAD, 2026-08-12 to 2026-09-28):\n\na1b2c3d|feat: bulk CSV import for contacts (#412)\ne4f5a6b|fix: NPE in ReportExporter.flush() when >10k rows (#418)\nc7d8e9f|feat!: remove legacy /v1/contacts endpoint (#420)\n0a1b2c3|chore(deps): bump lodash 4.17.20 -> 4.17.21\n4d5e6f7|refactor: extract ExportService\n8a9b0c1|fix stuff\n2d3e4f5|perf: cache tenant settings, report export ~3x faster (#425)",
|
|
7
7
|
"assertions": [
|
|
8
|
-
"
|
|
9
|
-
"The removal of /v1/contacts
|
|
8
|
+
"Delivers the notes from the log without stopping to ask who they are for, stating any assumption about the audience in a line",
|
|
9
|
+
"The removal of /v1/contacts comes first, with the step API users must take",
|
|
10
10
|
"Customer notes contain no commit-speak — no ReportExporter.flush(), class names, ticket numbers, or author names",
|
|
11
|
-
"The lodash bump and the ExportService refactor
|
|
12
|
-
"
|
|
13
|
-
"The vague 'fix stuff' commit
|
|
11
|
+
"The lodash bump and the ExportService refactor do not appear in customer-facing notes, not even as 'various improvements'",
|
|
12
|
+
"The notes carry no working notes: no commit range, commit count, hashes or review lists in customer-facing text",
|
|
13
|
+
"The vague 'fix stuff' commit is not given an invented meaning in the notes, and is named to the user outside them",
|
|
14
14
|
"No marketing adjectives; the performance line states the measured change (~3x faster export) rather than 'blazing fast'",
|
|
15
15
|
"Does not invent features or fixes not present in the log"
|
|
16
16
|
]
|
|
@@ -72,6 +72,34 @@
|
|
|
72
72
|
"It does not invent crash counts, percentages, a release date for Android, or features that are not in the list",
|
|
73
73
|
"The store text itself is short: about 100 words or fewer per store"
|
|
74
74
|
]
|
|
75
|
+
},
|
|
76
|
+
{
|
|
77
|
+
"id": 6,
|
|
78
|
+
"held_out": "2026-10-17",
|
|
79
|
+
"prompt": "Our next Quillmoor release goes out tomorrow. Quillmoor is our invoicing app for freelancers and small studios, and some of our customers use our API. The git log since the last release is in `git-log.txt`. Write the customer-facing release notes for our public changelog page: Markdown, 200 words max. I want them ready to paste.",
|
|
80
|
+
"assertions": [
|
|
81
|
+
"The webhook payload change (`amount` now an integer in minor units, `client_name` renamed to `client.display_name`) is in the notes and comes before every other change, worded so a customer with a webhook integration can tell they must update their handler",
|
|
82
|
+
"The Swiss QR-bill feature is not presented as part of the release, since it was reverted in the same range",
|
|
83
|
+
"No internal-only work appears in the notes: no CI changes, dependency bumps, test fixtures, the auth/session refactor, feature-flag removal, release checklist, or typo fixes in comments or CONTRIBUTING",
|
|
84
|
+
"The 'misc fixes from Henrike's QA pass' and 'sync stuff' commits are either left out or mentioned no more specifically than general small fixes; no particular behaviour, such as a sync feature, is attributed to them",
|
|
85
|
+
"Does not invent anything absent from the log or request: no version number, release date, PR or ticket number, count of changes, or figure such as how much faster the invoice list is",
|
|
86
|
+
"Covers at least six of these seven customer-visible changes: duplicating an invoice, receipt photos from a phone's browser, the client-portal ZIP download, no more reminders for invoices marked paid offline, the VAT rounding fix, the due date column in CSV export, and the faster invoice list",
|
|
87
|
+
"The pasteable notes are 200 words or fewer and in Markdown, are delivered without first stopping to ask questions, and contain no working notes about what was left out or why"
|
|
88
|
+
]
|
|
89
|
+
},
|
|
90
|
+
{
|
|
91
|
+
"id": 7,
|
|
92
|
+
"held_out": "2026-10-17",
|
|
93
|
+
"prompt": "I run the Bramblegate Tool Library, it's a volunteer thing where members borrow tools through our little app. My nephew does the app and he did a bunch of stuff this month. From memory:\n\n- you can reserve tools a week ahead now instead of 3 days? I think a week\n- the login code by text message, he fixed that, people were complaining it didn't arrive\n- something about late fees, he changed how they work, I need to check with him but basically you get a reminder before it's late now\n- everyone has to re-accept the borrowing agreement next time they log in because the committee updated it\n- new photos on the tool pages\n- also a lot of backend stuff I don't understand\n\nCan you write the text for the \"What's new\" pop-up members see when they open the app? It's a small box, so 75 words max.",
|
|
94
|
+
"assertions": [
|
|
95
|
+
"Re-accepting the updated borrowing agreement at next log-in comes first in the pop-up text and is stated as something the member will have to do",
|
|
96
|
+
"Does not invent details: no late-fee amounts, no number of days before the due date that the reminder arrives, no reservation window other than a week, no cause for the login problem, no date, and no change that is not in the notes",
|
|
97
|
+
"The late-fee item goes only as far as described, a reminder before an item is late, and does not claim fees were raised, lowered or removed",
|
|
98
|
+
"The 'backend stuff' is not in the pop-up text, and nothing specific is claimed about it",
|
|
99
|
+
"Mentions reserving further ahead, the fixed text-message login code, and the new tool photos",
|
|
100
|
+
"The pop-up text is 75 words or fewer and in plain language for library members, with no developer jargon such as 'backend', 'OTP' or 'SMS verification flow'",
|
|
101
|
+
"Delivers the pop-up text without first stopping to ask for confirmation; any suggestion to check details with the developer sits outside the pop-up text"
|
|
102
|
+
]
|
|
75
103
|
}
|
|
76
104
|
]
|
|
77
105
|
}
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
commit 0d1f6b8
|
|
2
|
+
Author: Jun Okafor
|
|
3
|
+
|
|
4
|
+
chore(release): scaffold release checklist
|
|
5
|
+
|
|
6
|
+
commit a4c91e0
|
|
7
|
+
Author: Odile Brandt
|
|
8
|
+
|
|
9
|
+
chore(ci): cache node_modules between workflow runs
|
|
10
|
+
|
|
11
|
+
commit 7d2b33f
|
|
12
|
+
Author: Tomasz Wereszka
|
|
13
|
+
|
|
14
|
+
Revert "feat(invoices): Swiss QR-bill block on PDF invoices"
|
|
15
|
+
|
|
16
|
+
This reverts commit 3e8f10b. The bank validator rejects our reference
|
|
17
|
+
field. Pulling it until we can test against real QR scanners.
|
|
18
|
+
|
|
19
|
+
commit e01f5c9
|
|
20
|
+
Author: Marisol Quintero
|
|
21
|
+
|
|
22
|
+
fix(reminders): stop sending payment reminders for invoices marked paid offline
|
|
23
|
+
|
|
24
|
+
Invoices marked "paid by bank transfer" by hand were still getting the
|
|
25
|
+
automatic reminder email sent to the client.
|
|
26
|
+
|
|
27
|
+
commit 5bb7a20
|
|
28
|
+
Author: Tomasz Wereszka
|
|
29
|
+
|
|
30
|
+
misc fixes from Henrike's QA pass
|
|
31
|
+
|
|
32
|
+
commit c33d9e4
|
|
33
|
+
Author: Jun Okafor
|
|
34
|
+
|
|
35
|
+
chore(deps): bump pdfkit from 0.13.0 to 0.15.1
|
|
36
|
+
|
|
37
|
+
commit 2f6a811
|
|
38
|
+
Author: Marisol Quintero
|
|
39
|
+
|
|
40
|
+
feat(expenses): attach receipt photos to expenses from your phone's browser
|
|
41
|
+
|
|
42
|
+
Camera upload on mobile web. JPG, PNG and HEIC, up to 10 MB each.
|
|
43
|
+
|
|
44
|
+
commit 88e0b4c
|
|
45
|
+
Author: Jun Okafor
|
|
46
|
+
|
|
47
|
+
refactor(webhooks): normalise payload serializer
|
|
48
|
+
|
|
49
|
+
Moves all webhook payloads onto the shared serializer. Side effect:
|
|
50
|
+
`amount` on invoice.created and invoice.paid is now an integer in minor
|
|
51
|
+
units (cents) instead of a decimal string, to match the REST API, and
|
|
52
|
+
`client_name` is renamed to `client.display_name`. Anyone parsing our
|
|
53
|
+
webhooks has to update their handler. There is no compatibility flag.
|
|
54
|
+
|
|
55
|
+
commit 41d7f02
|
|
56
|
+
Author: Tomasz Wereszka
|
|
57
|
+
|
|
58
|
+
test: add fixtures for multi-currency invoices
|
|
59
|
+
|
|
60
|
+
commit 3e8f10b
|
|
61
|
+
Author: Tomasz Wereszka
|
|
62
|
+
|
|
63
|
+
feat(invoices): Swiss QR-bill block on PDF invoices
|
|
64
|
+
|
|
65
|
+
Adds the QR payment slip to the bottom of PDF invoices for clients
|
|
66
|
+
with a Swiss address.
|
|
67
|
+
|
|
68
|
+
commit b9a2e6c
|
|
69
|
+
Author: Odile Brandt
|
|
70
|
+
|
|
71
|
+
sync stuff
|
|
72
|
+
|
|
73
|
+
commit 6c1d8a5
|
|
74
|
+
Author: Marisol Quintero
|
|
75
|
+
|
|
76
|
+
feat(invoices): duplicate an invoice from the invoice menu
|
|
77
|
+
|
|
78
|
+
Copies line items, client and tax settings. The new invoice gets the
|
|
79
|
+
next invoice number and today's date.
|
|
80
|
+
|
|
81
|
+
commit d57e3b1
|
|
82
|
+
Author: Jun Okafor
|
|
83
|
+
|
|
84
|
+
perf(dashboard): faster invoice list for accounts with lots of invoices
|
|
85
|
+
|
|
86
|
+
Paginate server-side instead of fetching every invoice up front.
|
|
87
|
+
|
|
88
|
+
commit 0ae4f9c
|
|
89
|
+
Author: Odile Brandt
|
|
90
|
+
|
|
91
|
+
docs: fix typo in CONTRIBUTING
|
|
92
|
+
|
|
93
|
+
commit f62c0d8
|
|
94
|
+
Author: Marisol Quintero
|
|
95
|
+
|
|
96
|
+
fix(tax): VAT total off by a cent on long invoices
|
|
97
|
+
|
|
98
|
+
Totals on invoices with many line items could be off by 0.01 because
|
|
99
|
+
we rounded each line instead of the total.
|
|
100
|
+
|
|
101
|
+
commit 19b7e44
|
|
102
|
+
Author: Jun Okafor
|
|
103
|
+
|
|
104
|
+
chore: remove unused feature flag new_sidebar_v1
|
|
105
|
+
|
|
106
|
+
commit ab30c6e
|
|
107
|
+
Author: Tomasz Wereszka
|
|
108
|
+
|
|
109
|
+
fix(export): CSV export now includes the due date column
|
|
110
|
+
|
|
111
|
+
commit 7e5d1f2
|
|
112
|
+
Author: Odile Brandt
|
|
113
|
+
|
|
114
|
+
ci: run e2e suite on Node 22
|
|
115
|
+
|
|
116
|
+
commit 2c94b8d
|
|
117
|
+
Author: Jun Okafor
|
|
118
|
+
|
|
119
|
+
refactor(auth): extract session middleware
|
|
120
|
+
|
|
121
|
+
commit 95f0a3c
|
|
122
|
+
Author: Marisol Quintero
|
|
123
|
+
|
|
124
|
+
feat(portal): clients can download all their paid invoices as one ZIP
|
|
125
|
+
|
|
126
|
+
New "Download all" button on the client portal's invoice page.
|
|
127
|
+
|
|
128
|
+
commit 4b6e7d9
|
|
129
|
+
Author: Odile Brandt
|
|
130
|
+
|
|
131
|
+
chore(deps-dev): bump eslint to 9.12
|
|
132
|
+
|
|
133
|
+
commit e8c2a05
|
|
134
|
+
Author: Tomasz Wereszka
|
|
135
|
+
|
|
136
|
+
chore: fix typos in code comments
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "release-notes",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.2.0",
|
|
4
|
+
"description": "Write release notes from a git log, a list of merged PRs or rough notes about what changed — for the audience and in the format the user names (a customer changelog page, an email, an in-app \"what's new\", store text, a CHANGELOG.md entry). Says nothing the input doesn't, writes a vague change only as far as it was described, puts breaking changes and anything the reader must do first, and keeps internal noise and working notes out of the text. Use when the user wants release notes, a changelog entry, \"what's in this release\", a deploy announcement, or to summarise changes since the last tag.",
|
|
5
5
|
"entrypoint": "SKILL.md",
|
|
6
6
|
"deps": { "npm": [], "pip": [] },
|
|
7
7
|
"env": { "required": [], "optional": [] },
|
|
8
8
|
"related": ["devils-advocate", "exec-summary", "pr-description-writer", "sonar-review"],
|
|
9
9
|
"tags": ["release-notes", "changelog", "git", "release", "deploy", "communication"],
|
|
10
|
-
"model": { "tier": "standard", "rationale": "
|
|
10
|
+
"model": { "tier": "standard", "rationale": "Reads a range for what really shipped and rewrites it for one reader. The audience translation needs judgment; escalate via large-input on very long ranges." }
|
|
11
11
|
}
|
|
@@ -1,83 +0,0 @@
|
|
|
1
|
-
# Release-notes templates
|
|
2
|
-
|
|
3
|
-
Two artifacts, two readers. Customer notes sell nothing and explain everything; the internal changelog trades polish for traceability.
|
|
4
|
-
|
|
5
|
-
## Artifact 1 — customer-facing release notes
|
|
6
|
-
|
|
7
|
-
> Note the deliberate rename for a non-technical reader: the Keep-a-Changelog categories **Added → New** and **Changed → Improved** here; Fixed/Security keep their names. The internal changelog (Artifact 2) uses the canonical Keep-a-Changelog headings.
|
|
8
|
-
|
|
9
|
-
```markdown
|
|
10
|
-
# {Product} {version} — {YYYY-MM-DD}
|
|
11
|
-
|
|
12
|
-
> Covers {ref}..{ref} · {N} changes
|
|
13
|
-
|
|
14
|
-
## ⚠ Breaking changes
|
|
15
|
-
|
|
16
|
-
- **{What broke, in reader terms.}**
|
|
17
|
-
Action required: {the exact step — config to change, endpoint to migrate, deadline}.
|
|
18
|
-
(flagged by: {signal — `!:` marker / removed API / migration file})
|
|
19
|
-
|
|
20
|
-
## New
|
|
21
|
-
|
|
22
|
-
- {What the reader can now do. One sentence, benefit first.}
|
|
23
|
-
|
|
24
|
-
## Improved
|
|
25
|
-
|
|
26
|
-
- {What got better, measurably where possible: "export is ~3× faster on reports over 10k rows".}
|
|
27
|
-
|
|
28
|
-
## Fixed
|
|
29
|
-
|
|
30
|
-
- {The symptom the reader no longer suffers: "Fixed a crash when …", "Dates no longer shift by one day when …".}
|
|
31
|
-
|
|
32
|
-
## Security
|
|
33
|
-
|
|
34
|
-
- {Reader-relevant statement; severity and affected versions; no exploit detail.}
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
Rules: no class/function/service names, no ticket IDs, no author names, no "various improvements". A section with nothing in it is deleted, not left empty — except Breaking changes, which when empty becomes the single line "No breaking changes."
|
|
38
|
-
|
|
39
|
-
## Artifact 2 — internal changelog (Keep a Changelog)
|
|
40
|
-
|
|
41
|
-
```markdown
|
|
42
|
-
## [{version}] - {YYYY-MM-DD}
|
|
43
|
-
|
|
44
|
-
Range: `{ref}..{ref}` · {N} commits · {N} PRs
|
|
45
|
-
|
|
46
|
-
### Added
|
|
47
|
-
- {change} ({#PR}, `{hash}`)
|
|
48
|
-
|
|
49
|
-
### Changed
|
|
50
|
-
- **BREAKING:** {change + migration step} ({#PR}, `{hash}`)
|
|
51
|
-
- {change} ({#PR}, `{hash}`)
|
|
52
|
-
|
|
53
|
-
### Fixed
|
|
54
|
-
- {change} ({#PR}, `{hash}`)
|
|
55
|
-
|
|
56
|
-
### Deprecated / Removed / Security
|
|
57
|
-
- {change} ({#PR}, `{hash}`)
|
|
58
|
-
|
|
59
|
-
### Internal
|
|
60
|
-
- {refactor / CI / deps / tests — one line each} (`{hash}`)
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
## Needs review (always emitted, both modes)
|
|
64
|
-
|
|
65
|
-
```markdown
|
|
66
|
-
## Needs review — {N} commits not classified
|
|
67
|
-
|
|
68
|
-
| Hash | Subject | Why unclear |
|
|
69
|
-
|---|---|---|
|
|
70
|
-
| `{hash}` | {verbatim subject} | {vague / contradicts diff / can't tell if user-visible} |
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
## Classification cheat-sheet
|
|
74
|
-
|
|
75
|
-
| Signal | Bucket |
|
|
76
|
-
|---|---|
|
|
77
|
-
| New endpoint, flag default-on, new UI surface | Added |
|
|
78
|
-
| Behavior or default changed for existing users | Changed (BREAKING if old behavior unobtainable) |
|
|
79
|
-
| `fix:`, bug ticket, regression revert | Fixed |
|
|
80
|
-
| `chore:`, `refactor:`, `test:`, `ci:`, deps, lockfiles | Internal |
|
|
81
|
-
| CVE, auth/authz, input validation, secrets | Security |
|
|
82
|
-
| `feat!:`, `BREAKING CHANGE:`, removed public API, schema migration, major version bump of a public SDK | Breaking — hoist to top |
|
|
83
|
-
| "wip", "fix stuff", "address comments", empty body + vague subject | Needs review |
|