magus v0.4.3 is out. See what's new
¶ View markdown source · ✎ Suggest an edit
1 min read

changelog-group

An advisory by default: it explains, and blocks nothing, on a changelog heading that is not Added, Changed, Deprecated, Removed, Fixed or Security.

What it catches

A changelog heading that is not Added, Changed, Deprecated, Removed, Fixed or Security.

Dimension

conventions: a house or genre convention is broken. A finding is counted on the dimension of its rule, the cost it names to the reader.

Why

The six groups are the ones Keep a Changelog names, and the ones this repository's fragment grammar accepts, so a reader finds a kind of change in the same place in every release. In release notes, which are looser, the rule advises and only for a heading that is a plain synonym ("Bug fixes", "Features").

Default decision

The code is PRF1031. The decision depends on the kind of text judged:

Kind Default
release-notes advise
changelog advise

Changing it

A decisions table sets this rule to deny, advise or off, for everything judged or for the files a glob matches. Proofread reads the table from the file its -decisions flag names:

{
  "rules": {"changelog-group": "deny"},
  "paths": {"blog/**": {"changelog-group": "off"}}
}

rules applies to every file. A glob in paths applies to the files it matches, and the last match wins. A rule set to off never reports.

Seeing it

A finding names the rule, its code and the decision that applies, and links here:

{"rule": "changelog-group", "code": "PRF1031", "decision": "advise", "url": "https://eli.gladman.cc/magus/reference/proofread/changelog-group/"}

proofread rules prints this entry with every other rule's.

See also

ReferencePages in this section. bare-imperativeAn advisory by default: it explains, and blocks nothing, on a short command in a review reply that gives no reason anywhere ("Fix this."). buzzword-weakAn advisory by default: it explains, and blocks nothing, on a buzzword that also has an ordinary sense ("crucial", "landscape"). changelog-entryAn advisory by default: it explains, and blocks nothing, on a changelog entry that names a Go identifier and says little else.
proofreadruleschangelog-groupadvise
Last updated (87041fca)
Earlier changes on this page (2)

Full history ↗ · Blame source ↗

Glossary

CI

An ordinary target you compose yourself with ctx.needs; magus does not hardcode its stages. It is the anchor magus affected ci keys off, and ci strips the rw charm. CI in full.

Lease

The grant a holder takes on a job: the write and read paths that job declared, enforced in the checkout that took it with magus job exec. A job is the piece of work; a lease is permission over it. Lease in full.

Advisor

One read-only check from the advice suite: it reads the changeset through magus and writes one titled section of findings. The same advisors run as a pull request comment in CI and inside magus diff --impact locally. Advisor in full.

Conventions

This page uses none of the site's convention markers. The full set is on the conventions page.