Skip to content

Releases: halos-org/docs-tools

v0.2.0 — gate stale on the change, not the repository

Choose a tag to compare

@mairas mairas released this 13 Aug 17:01
33256b5

translation-status --since REF

Whole-repository --check has a cost that only shows up in use: editing one English page marks every translation of it stale, so a typo fix cannot go green until all nine translations land in the same pull request. And because the gate reads the repository rather than the diff, a page somebody left behind last month fails a pull request that touched no documentation at all.

--since REF gates on stale only for English pages whose content differs from REF. missing, unstamped and orphaned still fail wherever they came from — those are structural, and none asks an author for translation work their own change did not create.

  • What the gate passed over is printed. A green run that silently forgave two stale translations reads exactly like a repository with none.
  • An unresolvable REF exits 2, not 0. A gate that cannot tell which pages a change touched would otherwise forgive all of them; a shallow clone is the realistic trigger.
  • Applies to --comment as well as --check, so the pull request comment and the gate cannot disagree.

Verified against hatlabs/halpi2 and hatlabs/sh-rpi, not only the test fixture.

Also

  • The exit-status table in the README promised status 2 only for check-anchors. It was already wrong — translation-status returns 2 for no configured locales, no source pages, and markdown outside every configured locale.
  • AGENTS.md said no consumer pinned the package yet, which stopped being true when halos-org/docs#38 merged.

Upgrading

Bump the pin and re-lock:

halos-docs-tools @ git+https://github.com/halos-org/docs-tools@v0.2.0

Nothing existing changes behaviour: --check without --since gates exactly as it did in v0.1.0.

v0.1.0

Choose a tag to compare

@mairas mairas released this 13 Aug 12:03
7f09d05

First release. Six documentation checkers as console commands: translation-status, stamp-translation, map-anchors, check-glossary, check-typography, check-anchors.

Pin it in a documentation repository's pyproject.toml:

dependencies = [
    "halos-docs-tools @ git+https://github.com/halos-org/docs-tools@v0.1.0",
]