@descent-vtt/spec-graph 0.9.10 → 0.11.0

package/CHANGELOG.md

@@ -1,7 +1,91 @@
 # Changelog
 
-Notable changes, newest first. Versions follow [semver](https://semver.org):
-a patch fixes behaviour without asking anything of a repository that upgrades.
+Notable changes, newest first. Before 1.0, anything that can turn a passing
+run red or change what a script reads - a new finding, a changed exit code,
+input refused that was accepted, a renamed flag or JSON field - comes in a
+minor release, 0.9 to 0.10, with new features; a patch only reports less,
+fixes a crash, runs faster or corrects the documentation, so `^0.10.0` takes
+no release that can fail a build that passed. A flag, key or field is
+deprecated with a warning for at least one minor release before it goes, as
+the family's
+[versioning policy](https://github.com/DescentVTT/spec-core/blob/main/docs/adr/0009-versions-before-1-0.md)
+records.
+
+## 0.11.0
+
+spec-graph reads English only again, by the maintainer's decision; the
+two-column status table stays with English keys. spec-core's copy is
+unchanged.
+
+### Removed
+
+- Statuses, relations, obligation and bookkeeping headings and markers
+  written in Chinese are no longer read: a Chinese status word, `狀態` or
+  `状态` as a status key, heading, label or table key, and a full-width
+  colon after a status label or heading give an unknown phase, and a
+  Chinese phrase, heading or marker draws nothing. The two-column status
+  table stays, with `Status` and `State`, and so do the stop at `。？！；`
+  and a full-width comma or semicolon between successors (ADR-0002,
+  ADR-0003, ADR-0006). Upgrading: write the status in English, e.g.
+  `status: superseded`.
+
+## 0.10.0
+
+Statuses, status tables, relations, obligations and markers written in
+Chinese are read, and `check` writes GitHub annotations. Over this
+repository, its fixtures and the rest of the family, which write neither,
+every `check` format and graph export is byte for byte what 0.9.10 wrote.
+spec-core is at 5666c96.
+
+### Added
+
+- `check --format github` writes one GitHub Actions workflow command per
+  finding, with the hint in the message; severities as spec-guard's.
+
+### Changed
+
+- A status written in Chinese, Traditional or Simplified, is read as the
+  English word it translates (`已接受` accepted, `延後` deferred, `封存`
+  archived, `已被 ADR-0003 取代` superseded by ADR-0003), from front matter
+  (`狀態:`), a `## 狀態` section or a register label (ADR-0002). Upgrading:
+  run `check`; fix what a rule now finds on a Chinese document, or baseline
+  it with `--record-baseline <file>`.
+- A two-column table above the first `##`, `| 狀態 | 已接受 |` or
+  `| Status | Accepted |`, gives the status, after a `## Status` section and
+  never over front matter (ADR-0002). Upgrading: as above.
+- Hand-off phrases (`延後至`, `移交給`, `留待`, `交由`, `併入`), obligation
+  and bookkeeping sections (`待辦事項`, `未決問題`, `參考資料`, `附錄`) and
+  markers (`已解決：`, `已決定：`, `**技術債**`) written in Chinese are read,
+  not after a negation (ADR-0003, ADR-0006). Upgrading: as above.
+- A pattern typed below the root is rebased alternative by alternative:
+  `{/docs,x}` in `sub` is `/docs` or `sub/x`, `!/docs` stays rooted, and
+  `{../a,b}` in `sub/deep` works; a `..` past the root, an empty pattern, a
+  directory name holding glob syntax and `{/,x}` exit 2 (ADR-0018,
+  ADR-0022). Upgrading: write `{docs,x}` for what `{/docs,x}` read in a
+  subdirectory.
+- `.//docs` reads as `./docs`, where it was rooted and matched nothing
+  (ADR-0022). Upgrading: nothing to change.
+
+### Fixed
+
+- A statement ends at `。？！；`, so a Chinese phrase no longer governs a
+  reference in the next sentence.
+- A front-matter key in any script is read, where it was counted as a
+  problem line on every run.
+- A bare `--history` name typed below the root is read from where it was
+  typed (ADR-0018).
+- The `--record-baseline` hint names the file as typed where the run was
+  (ADR-0018).
+- The terminal report lines up paths in Chinese, and the caret under a
+  selector that does not parse.
+- The README's SARIF example uses `upload-sarif@v4` and the
+  `security-events: write` permission it needs.
+
+### Documentation
+
+- The README is reorganised into lists and tables with nothing left out,
+  links the family's glossary and tutorial, and SECURITY.md says how to
+  report a vulnerability privately.
 
 ## 0.9.10