@descent-vtt/spec-graph 0.9.9 → 0.10.0

package/CHANGELOG.md

@@ -1,7 +1,137 @@
 # 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.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
+
+A `!` before a bare `--ignore` name gives the name back, as `.gitignore`
+does, where it did nothing; a refused `--ignore-ref` pattern is advised as it
+was typed; a followed link back into a directory the walk is inside is not
+walked again; and spec-core is at 7e41240, so a leading `/` on a brace
+alternative roots it as it roots a pattern alone. A repository with none of
+these sees nothing change.
+
+### Fixed
+
+- **spec-core 7e41240: a leading `/` on a brace alternative means what it
+  means on the pattern written alone.** It was dropped, so `{/docs,x}` read
+  `docs`. As a pattern to check, `{/docs/*.md,x/*.md}` read every file in
+  `docs` where `/docs/*.md` reads none, and `{/dist,docs}` read the `dist`
+  the walk skips; as an `--ignore` or a `--history` pattern, `{/docs,x}` took
+  out, or made records of, what is in `docs` where `/docs` takes out
+  nothing; and `--ignore-ref "{/docs/a.md,x}"` passed over the target
+  `docs/a.md` and not `/docs/a.md`. Each such alternative now reads as the
+  text alone does, from the configuration as from the command line: rooted
+  at the filesystem's root, which nothing under the root is, and for
+  `--ignore-ref` the target `/docs/a.md`. `globBase("{/docs/*.md}")` is
+  `/docs`, as `globBase("/docs/*.md")` is. A `/` before the braces,
+  `/{docs,x}`, and one after a segment, `docs/{/adr,x}`, read as they did.
+  Typed in a directory below the root, the pattern is re-anchored whole, as
+  before, so `{/docs,x}` typed in `sub` still reads `sub/docs` (ADR-0022).
+  No configuration in this repository, its fixtures or the rest of the
+  family writes such a pattern, and over them every `check` format and every
+  graph export is byte for byte what 0.9.9 wrote.
+- **A `!` before a bare `--ignore` name gives the name back.**
+  `--ignore docs --ignore "!docs"` pruned every `docs` and said nothing, and
+  `--ignore "!vendor"` read no `vendor`: a name without a slash was read as a
+  bare name, so `!docs` pruned a directory called `!docs`. The bare names are
+  now read in order, the last to name a directory deciding, and a `!` before
+  one gives back a directory an earlier bare name or the default list prunes,
+  at any depth and where a pattern starts inside it; the rest of the default
+  list is still pruned inside it. A `!` before a path is unchanged, and a `!`
+  alone or before another `!` is refused, where it pruned a directory of that
+  name. A directory whose name begins with `!` is named in braces,
+  `**/{!drafts}` (ADR-0022). No configuration in this repository, its
+  fixtures or the rest of the family writes such an ignore, and over them
+  every `check` format and every graph export is byte for byte what 0.9.9
+  wrote.
+- **A refused `--ignore-ref` pattern is advised as it was typed.**
+  `--ignore-ref "../notes/**.md"` stopped the run with
+  `write "\.\./notes/**/*.md" for any depth, or "\.\./notes/*.md" for one level`:
+  the backslashes were the ones the filter adds to read a `.` or `..` as
+  text. It now says `write "../notes/**/*.md" for any depth, or
+  "../notes/*.md" for one level`, inside braces as outside. The exit `2`, the
+  pattern the message names, and what every pattern matches are as they were
+  (ADR-0022): over this repository, its fixtures and the rest of the family
+  every `check` format and every graph export is byte for byte what 0.9.9
+  wrote.
+- **With `followSymlinks` on, a link back into a directory the walk is
+  inside is not followed.** A link to a directory above it, such as
+  `docs/sub/up` to `docs`, was walked round and round, reading the same
+  files under a longer path each time until the host refused the path: on
+  Windows, 64 copies of each file, and with two such links, minutes of
+  walking. Such a link is now passed over as silently as every link is when
+  links are not followed, so each file is read once, and a pattern that
+  starts beyond one finds nothing. A link to a sibling or to a directory
+  outside the tree is followed as before (ADR-0022). The command line never
+  follows a link, so it sees nothing change.
 
 ## 0.9.9