Skip to content

v0.9.0

Choose a tag to compare

@github-actions github-actions released this 27 Sep 20:21
· 243 commits to main since this release

Added

  • The content health page at /content-health/. It groups what editors have
    to fix by the action that fixes it, with an instruction for each check.
    Each document links to its page and to Google Docs, at the line concerned
    when there is one. Filters narrow the list to one section or to whoever last
    edited the document. It is not in the sidebar or in search. See
    ADR-024.
  • Checks in the title report:
    • a heading that mixes alphabets, now read from the source with a link to
      it;
    • a document that opens with another document's title;
    • an empty document;
    • the proposed one-Title-line convention (title styled as Heading 1, no
      title line, title not first, Title style on a section);
    • Drive names with "Copy of", a file extension, underscores or extra spaces.
  • The sync's job summary lists the checks as counts, with a link to the page.
  • Who last edited each document, from Drive's lastModifyingUser display
    name.
  • ctcdocs-sync validate fails when the project's Prettier configuration
    would format a generated path, and names each one to add to
    .prettierignore. It asks Prettier itself, reading .gitignore and
    .prettierignore the way prettier --check . does, and it checks every
    path the allowlist names whether or not the sync has written it yet. A
    project that listed generated files one by one did not ignore
    data/title-report.json after 0.8.0, and learned so only when a full sync
    had exported everything and then failed its format check.

Changed

  • content-health is a platform route.
  • The title report moves to schema version 2. It lists its checks, and each
    document lists its issues, section and last editor. Facts recorded by 0.8.0
    count as not inspected: run a full sync once after upgrading.
  • Title similarity takes the better of character edit similarity and shared
    words, and a reordered title is classified as reordered.
  • The Docs API request also reads each paragraph's heading ID.
  • @ctcstack/ctcdocs-sync declares prettier 3 as a peer dependency. Every
    project already installs it for its format check; validation now uses the
    same copy, so the answer is the one the format check would give.
  • @ctcstack/ctcdocs declares prettier 3 as a peer dependency as well. It
    ships the shared Prettier configuration, so it always needed one; the
    requirement is now stated rather than assumed.