panates / rman / 36582422183

95%

Build Type

push

github

Committed by erayhanoglu

Commit Message

feat(changelog): a section per standard commit type, no repeated message, a sha on every line

Three changes to how an entry renders, all reported from real changelogs.

**A repeated message is written once per section.** Measured on panates/postgrejs,
whose v2.22.1 entry read `Updated config` five times - five commits really worded
the same, so it is not rman inventing them, and the repetition states nothing the
first line did not. Deduplicated per section rather than per entry: `feat: x` and
`fix: x` are different claims under different headings, and collapsing those would
lose a fact rather than a repetition. Keyed on the message *before* the sha is
appended, which is the whole subtlety - with the sha on the line every duplicate is
textually unique and the check would never fire. The survivor keeps the earliest
commit of the run.

**Each bullet ends with its commit's short sha**, plain and never a Markdown link:
GitHub autolinks an abbreviated sha wherever it renders Markdown inside the
repository, so `(a1b2c3d)` is a link on the page and still readable in a terminal,
where a hand-built URL would need to know the forge. `changelog.commitHash` /
`--no-commit-hash` turns it off. No `default: true` on the yargs option - the same
trap `unreleased` avoids, since an omitted flag would then arrive as `true` and the
config key could never speak.

**A heading for every standard Conventional Commits type.** rman named three, so
everything else fell into one heap: counted across four of this organization's
repositories, that heap held 194 chore, 86 docs, 68 refactor, 29 test, 27 ci and 24
perf - more commits than feat and fix together, under a heading saying only "not one
of those two". The set stops at the standard types; `dev` and `bench` are this
organization's own and belong in its own `titles`. They add sections and hide
nothing - `ignoreTypes` stays the only key that drops a type, unlike
conventional-changelog's default preset, which silently omits five... (continued)

Coverage Stats

2920 of 3200 branches covered (91.25%)

Branch coverage included in aggregate %.

123 of 123 new or added lines in 3 files covered. (100.0%)

18 existing lines in 2 files now uncovered.

17574 of 18554 relevant lines covered (94.72%)

197.28 hits per line