@descent-vtt/spec-guard 0.16.0 → 0.18.0

package/CHANGELOG.md

@@ -1,9 +1,94 @@
 # Changelog
 
-All notable changes to this project are documented here. Versions follow
-[semantic versioning](https://semver.org), with the 0.x caveat that behaviour
-may change in a minor release — each such change is listed under **Changed**
-with the flag that restores the previous behaviour.
+All notable changes to this project are documented here. Before 1.0 a minor
+release (0.16.x to 0.17.0) carries anything that can turn a passing run red or
+change what a script reads - a finding or a failure that was not there, a
+changed exit code or JSON field, input refused that was accepted - and a patch
+only what reports less, crashes, performance and documentation, so `^0.17.0`
+takes no release that can turn a run red. Each entry under **Changed** says
+what to do when upgrading; the family's policy, including how a flag or field
+is deprecated before it goes, is spec-core's
+[ADR-0009](https://github.com/DescentVTT/spec-core/blob/main/docs/adr/0009-versions-before-1-0.md).
+
+## 0.18.0
+
+spec-guard reads a status in English only again, by the maintainer's
+decision: a Chinese status stays in force with a warning whose hint asks for
+an English word. The two-column status table stays with English keys.
+
+### Removed
+
+- A status written in Chinese is no longer read, and neither is `狀態` or
+  `状态` as the status key. Under an English key, `status: 已取代` is a status
+  that cannot be read: the document stays in force, with a warning whose
+  `hint` says to write the status as an English word; every such warning now
+  carries that hint in `hint`, where 0.17.0 carried one only for a full-width
+  colon, and GitLab and GitHub show it after the message. A heading, label,
+  table row or front-matter key in Chinese names no status, so an English
+  status below it decides
+  ([ADR-0010](https://github.com/DescentVTT/spec-guard/blob/main/docs/adr/0010-spec-status.md)).
+  The warning for `狀態：` with a full-width colon in front matter goes with
+  them. A two-column status table is still read, with `Status` or `State` as
+  the key. Upgrading: write the status in English, e.g. `status: superseded`.
+
+## 0.17.0
+
+Chinese statuses and status tables are read, `--strict` refuses a run that
+verified nothing, a hint travels with every finding to GitLab and GitHub,
+fingerprints no longer follow a message's wording, and spec-core is at
+5666c96.
+
+### Changed
+
+- A status written in Chinese is read as the English word it translates
+  (`已取代` superseded, `草稿` draft, `延後` deferred), from a heading, a
+  label with `:` or `：`, a table, or front matter (`狀態:`); only the six
+  English words withhold a document ([ADR-0010](https://github.com/DescentVTT/spec-guard/blob/main/docs/adr/0010-spec-status.md)).
+  Upgrading: a Chinese ADR marked superseded, deprecated, rejected, archived,
+  draft or proposed stops running its rules; write its status in English or
+  run with `--ignore-status` to keep them.
+- A two-column table before the first section whose left cell is `Status`,
+  `State`, `狀態` or `状态` gives the status, after a `## Status` section.
+  Upgrading: as above.
+- A `## Status` section or label that cannot be read keeps its document in
+  force with a warning, where it fell through to a later label. Upgrading:
+  write the status in the section.
+- Under `--strict`, a run or `prove` that executed no assertion exits 1, with
+  a `nothing-verified` finding in every format; a selection that picks no
+  rule still passes (ADR-0010). Upgrading: put a rule in force, fix the spec
+  patterns, or pass `--no-strict`.
+- `cites --strict` that read no source file writes a `nothing-read` finding
+  in every format; its exit code is unchanged
+  ([ADR-0017](https://github.com/DescentVTT/spec-guard/blob/main/docs/adr/0017-citations-in-comments.md)).
+  Upgrading: a code-scanning or GitLab report shows one finding where it
+  showed none.
+- GitLab descriptions and GitHub messages carry the hint after the message.
+  Upgrading: nothing, unless a script compares a description whole.
+- The GitLab and SARIF fingerprints of a directive that cannot be read are
+  built from the directive as written, never its message. Upgrading: each
+  such issue or alert closes and reopens once.
+- spec-core at 5666c96: `.//f.ts` is `f.ts` at any depth, as `./f.ts` is,
+  in every pattern and under both engines, where it meant the root
+  ([ADR-0015](https://github.com/DescentVTT/spec-guard/blob/main/docs/adr/0015-globs-from-spec-core.md),
+  [ADR-0013](https://github.com/DescentVTT/spec-guard/blob/main/docs/adr/0013-structure-assertions.md)).
+  Upgrading: write `/f.ts` for the root.
+
+### Fixed
+
+- `glob="./!a"` and the spec pattern `./!*.md` name files called `!a` and
+  `!*.md`, where they were refused as negations.
+- `impact` lines up paths in Chinese, Japanese or Korean.
+- The README describes the GitLab fingerprint as the code builds it, lists
+  the `spec-warning` severity, says how to install ripgrep on GitLab runners
+  and Windows, and uploads SARIF with `upload-sarif@v4`.
+
+### Documentation
+
+- The README is reorganised: the directive reference sits under Directives,
+  Design decisions is an index of the ADRs, and development, mutation testing
+  and releasing moved to CONTRIBUTING.md, with the release flow in
+  [ADR-0019](https://github.com/DescentVTT/spec-guard/blob/main/docs/adr/0019-releases-are-staged-by-ci.md);
+  SECURITY.md says how to report a vulnerability privately.
 
 ## 0.16.0