Conventional Release
A widely-used release pattern: every PR is squash-merged, its title is a
Conventional Commit, and an automated tool on the default
branch reads the commit type to calculate the next SemVer tag, cut a release,
and generate the changelog. No human writes a version number or a changelog entry by hand — the merge
title is the release note, and the type is the bump.
Use this skill whenever you open or merge a PR into a repository that releases this way, or when you
need to decide which version a change should produce.
How to tell a repo uses this pattern
Look for any one of:
- A release tool wired to run on push to the default branch:
semantic-release,
release-please,
mathieudutour/github-tag-action, or
Changesets.
- Branch protection that only allows squash merging (so the PR title is the sole commit message
that reaches the default branch).
- A
CHANGELOG.md that is generated, or release notes grouped by Features / Bug Fixes.
- A
commitlint/commitizen config, or CI that lints the PR title against the Conventional Commits
spec.
If the repo squash-merges but releases manually, the title still matters for history and review — keep
writing Conventional Commit titles, but the version step is the maintainer's.
The non-negotiable: the squash title is the only message that survives
With squash merging, GitHub collapses every commit on the branch into one commit on the default
branch, and that commit's message defaults to the PR title. The release tool reads that message.
So:
- The individual commits on your branch do not drive the release — only the final squash message
does. Tidy WIP commits are fine; the PR title is what counts.
- The PR title MUST be a single valid Conventional Commit line. A title like
[fix] thing or
WIP: thing or Update README either yields no release, the wrong bump, or a corrupted changelog
entry.
- Never put a bracketed prefix, ticket id, or label in the title (
[infra], JIRA-123:,
(wip)). Attribution belongs in labels and the branch name, never the title — a prefix
before the type breaks the parser and pollutes the release notes.
Anatomy of the title
<type>(<optional scope>): <imperative summary>
<type> — one of the types below; it selects the version bump.
(<scope>) — optional, a noun for the area touched: feat(api):, fix(parser):. Keep it short and
consistent with the repo's existing scopes.
<summary> — imperative mood (add, not added/adds), lower-case start, no trailing period,
kept under ~72 chars. Describe the change from the user's perspective, because it becomes their
changelog line.
Type → version bump
The default mapping (Angular/Conventional Commits preset, used by all four tools above):
| Type |
Meaning |
Bump |
feat |
a new user-facing capability |
minor (x.Y.0) |
fix |
a bug fix |
patch (x.y.Z) |
perf |
a performance improvement |
patch (often) |
docs |
documentation only |
none by default |
refactor |
behaviour-preserving code change |
none by default |
test |
adding or fixing tests |
none by default |
build / ci |
build system or pipeline |
none by default |
chore |
maintenance, deps, tooling |
none by default |
style |
formatting only |
none by default |
revert |
revert a prior change |
patch (often) |
A push that contains only no-bump types yields no release — a deliberate, green "nothing to
ship" outcome, not a failure. Do not invent a feat: to force a tag.
Breaking changes → major
A breaking change is a major bump (X.0.0), signalled either way:
a ! after the type/scope: feat(api)!: drop the v1 endpoint, or
a BREAKING CHANGE: footer in the body:
feat(api): replace the auth header
BREAKING CHANGE: clients must send `Authorization: Bearer` instead of `X-Token`.
Pre-1.0 (0.y.z) repos may map breaking changes to a minor bump instead — check the repo's release
config (semantic-release and release-please honour SemVer's 0.x rules). When unsure, state the
breaking nature explicitly and let the tool decide the number.
Choosing the bump deliberately
Pick the type from the effect on the consumer, not the size of the diff:
- A one-line change that alters output a user depends on is a
fix (or a breaking feat!), not a
chore.
- A 500-line internal refactor that changes no behaviour is
refactor — none — even though it is
large.
- Bumping a dependency that changes runtime behaviour the user sees is a
fix/feat; a dev-only or
pinned-tooling bump is chore.
- Splitting unrelated changes across PRs lets each get its correct type and its own release note —
prefer that over one mixed PR with a vague title.
Writing the body
The body is optional for simple changes and flows into the release notes under the title. Use it to:
- explain why, not just what (reviewers and the changelog reader both benefit);
- add a
BREAKING CHANGE: footer for majors (see above);
- reference issues with
Fixes #123 / Closes #123 so the merge closes them;
- credit co-authors with
Co-authored-by: trailers.
Keep wrap at ~72 columns; the first body line must be blank (separating it from the title).
Pitfalls
- Title fixed after approval but before merge. Reviewers may approve a draft title; always
re-read the final title at merge time — it is what ships. Many UIs pre-fill the squash message from
the first commit, not the PR title; confirm the squash message equals the intended title before
confirming the merge.
- Multiple logical changes, one PR. The single title can only carry one type. Either split the PR
or pick the highest-impact type and enumerate the rest in the body.
- No-bump type when you meant to release.
chore: add retry to the client ships nothing; if users
get the retry, it is a fix/feat.
- Reverting a release. Use
revert: (or the tool's revert convention) so the changelog records the
rollback rather than a silent gap.
- Scope sprawl. Inconsistent scopes (
api, API, apis) fragment the changelog; reuse the scopes
already present in the history.
Verify before merging
- The PR title parses as
<type>(<scope>)?: <summary> with a real type — no bracket/prefix, no
trailing period, imperative mood.
- The chosen type produces the intended bump (or an intended no release).
- Any breaking change carries
! or a BREAKING CHANGE: footer.
- The squash-merge message the platform will use equals that title (re-check at the merge dialog).
- If the repo lints commits/titles in CI, that check is green — fix the title, never bypass the lint.
Related skills
git-commit — compose a Conventional Commit message from a working-tree diff (the local-author
side of the same convention).
ways-of-working — the broader issue → plan → implement → test → review flow these releases sit in.
1---2name: conventional-release-23description: Ship changes through a squash-merge + Conventional Commits release pipeline where the PR title becomes the release note and the commit type drives the next semantic version. Use when writing a PR title or commit message that feeds an automated release, choosing the version bump for a change, setting up or reasoning about semantic-release / release-please / github-tag-action / Changesets, or avoiding a title that corrupts the changelog.4license: Apache-2.05---67# Conventional Release89A widely-used release pattern: every PR is **squash-merged**, its **title is a10[Conventional Commit](https://www.conventionalcommits.org/)**, and an automated tool on the default11branch reads the commit type to calculate the next [SemVer](https://semver.org/) tag, cut a release,12and generate the changelog. No human writes a version number or a changelog entry by hand — the merge13title *is* the release note, and the type *is* the bump.1415Use this skill whenever you open or merge a PR into a repository that releases this way, or when you16need to decide which version a change should produce.1718## How to tell a repo uses this pattern1920Look for any one of:2122- A release tool wired to run on push to the default branch:23 [`semantic-release`](https://github.com/semantic-release/semantic-release),24 [`release-please`](https://github.com/googleapis/release-please),25 [`mathieudutour/github-tag-action`](https://github.com/mathieudutour/github-tag-action), or26 [Changesets](https://github.com/changesets/changesets).27- Branch protection that **only allows squash merging** (so the PR title is the sole commit message28 that reaches the default branch).29- A `CHANGELOG.md` that is generated, or release notes grouped by `Features` / `Bug Fixes`.30- A `commitlint`/`commitizen` config, or CI that lints the PR title against the Conventional Commits31 spec.3233If the repo squash-merges but releases manually, the title still matters for history and review — keep34writing Conventional Commit titles, but the version step is the maintainer's.3536## The non-negotiable: the squash title is the only message that survives3738With squash merging, GitHub collapses every commit on the branch into **one** commit on the default39branch, and that commit's message defaults to the **PR title**. The release tool reads *that* message.40So:4142- **The individual commits on your branch do not drive the release** — only the final squash message43 does. Tidy WIP commits are fine; the PR title is what counts.44- **The PR title MUST be a single valid Conventional Commit line.** A title like `[fix] thing` or45 `WIP: thing` or `Update README` either yields no release, the wrong bump, or a corrupted changelog46 entry.47- **Never put a bracketed prefix, ticket id, or label in the title** (`[infra]`, `JIRA-123:`,48 `(wip)`). Attribution belongs in **labels** and the **branch name**, never the title — a prefix49 before the type breaks the parser and pollutes the release notes.5051## Anatomy of the title5253```text54<type>(<optional scope>): <imperative summary>55```5657- `<type>` — one of the types below; it selects the version bump.58- `(<scope>)` — optional, a noun for the area touched: `feat(api):`, `fix(parser):`. Keep it short and59 consistent with the repo's existing scopes.60- `<summary>` — imperative mood (`add`, not `added`/`adds`), lower-case start, no trailing period,61 kept under ~72 chars. Describe the change from the *user's* perspective, because it becomes their62 changelog line.6364## Type → version bump6566The default mapping (Angular/Conventional Commits preset, used by all four tools above):6768| Type | Meaning | Bump |69|------|---------|------|70| `feat` | a new user-facing capability | **minor** (`x.Y.0`) |71| `fix` | a bug fix | **patch** (`x.y.Z`) |72| `perf` | a performance improvement | patch (often) |73| `docs` | documentation only | **none** by default |74| `refactor` | behaviour-preserving code change | none by default |75| `test` | adding or fixing tests | none by default |76| `build` / `ci` | build system or pipeline | none by default |77| `chore` | maintenance, deps, tooling | none by default |78| `style` | formatting only | none by default |79| `revert` | revert a prior change | patch (often) |8081A push that contains **only** no-bump types yields **no release** — a deliberate, green "nothing to82ship" outcome, not a failure. Do not invent a `feat:` to force a tag.8384### Breaking changes → major8586A breaking change is a **major** bump (`X.0.0`), signalled either way:8788- a `!` after the type/scope: `feat(api)!: drop the v1 endpoint`, **or**89- a `BREAKING CHANGE:` footer in the body:9091 ```text92 feat(api): replace the auth header9394 BREAKING CHANGE: clients must send `Authorization: Bearer` instead of `X-Token`.95 ```9697Pre-1.0 (`0.y.z`) repos may map breaking changes to a **minor** bump instead — check the repo's release98config (`semantic-release` and `release-please` honour SemVer's 0.x rules). When unsure, state the99breaking nature explicitly and let the tool decide the number.100101## Choosing the bump deliberately102103Pick the type from the **effect on the consumer**, not the size of the diff:104105- A one-line change that alters output a user depends on is a `fix` (or a breaking `feat!`), not a106 `chore`.107- A 500-line internal refactor that changes no behaviour is `refactor` — **none** — even though it is108 large.109- Bumping a dependency that changes runtime behaviour the user sees is a `fix`/`feat`; a dev-only or110 pinned-tooling bump is `chore`.111- Splitting unrelated changes across PRs lets each get its correct type and its own release note —112 prefer that over one mixed PR with a vague title.113114## Writing the body115116The body is optional for simple changes and flows into the release notes under the title. Use it to:117118- explain **why**, not just what (reviewers and the changelog reader both benefit);119- add a `BREAKING CHANGE:` footer for majors (see above);120- reference issues with `Fixes #123` / `Closes #123` so the merge closes them;121- credit co-authors with `Co-authored-by:` trailers.122123Keep wrap at ~72 columns; the first body line must be blank (separating it from the title).124125## Pitfalls126127- **Title fixed *after* approval but *before* merge.** Reviewers may approve a draft title; always128 re-read the final title at merge time — it is what ships. Many UIs pre-fill the squash message from129 the first commit, **not** the PR title; confirm the squash message equals the intended title before130 confirming the merge.131- **Multiple logical changes, one PR.** The single title can only carry one type. Either split the PR132 or pick the highest-impact type and enumerate the rest in the body.133- **No-bump type when you meant to release.** `chore: add retry to the client` ships nothing; if users134 get the retry, it is a `fix`/`feat`.135- **Reverting a release.** Use `revert:` (or the tool's revert convention) so the changelog records the136 rollback rather than a silent gap.137- **Scope sprawl.** Inconsistent scopes (`api`, `API`, `apis`) fragment the changelog; reuse the scopes138 already present in the history.139140## Verify before merging1411421. The PR title parses as `<type>(<scope>)?: <summary>` with a real type — no bracket/prefix, no143 trailing period, imperative mood.1442. The chosen type produces the **intended** bump (or an intended *no* release).1453. Any breaking change carries `!` or a `BREAKING CHANGE:` footer.1464. The squash-merge message the platform will use **equals** that title (re-check at the merge dialog).1475. If the repo lints commits/titles in CI, that check is green — fix the title, never bypass the lint.148149## Related skills150151- `git-commit` — compose a Conventional Commit *message* from a working-tree diff (the local-author152 side of the same convention).153- `ways-of-working` — the broader issue → plan → implement → test → review flow these releases sit in.