Skip to content

Adopt the relaton local cache as the committed bib database - #20

Merged
ronaldtse merged 1 commit into
mainfrom
chore/relaton-local-cache
Nov 5, 2026
Merged

ronaldtse merged 1 commit into
mainfrom
chore/relaton-local-cache

Conversation

@ronaldtse

Copy link
Copy Markdown
Contributor

Summary

Implements the metanorma.org authoring guidance for reference lookups (author/basics/reference-lookups.adoc: local Relaton cache stores are portable directories "often committed into version control for faster and more reproducible continuous integration build times"):

  • All six documents compile with :local-cache: (fetch when missing, persist) instead of :local-cache-only: (never fetch — which silently drops any reference absent from the cache).
  • sources/*/relaton is committed as the portable bib database (currently the ECMA-376 entry; the BIPM/JCGM entries populate on CI, which reaches the bipm endpoints).
  • .notfound / .redirect negative markers are gitignored — a committed marker poisons the cache and silently drops the reference on every future build — and the validator now fails on any that appear (pass 2a), alongside the existing bibliography checks.
  • PM 1006's bare JCGM 101 anchor gains trailing text (bare anchors render empty citation chips; caught by the existing check).

Test plan

  • ruby scripts/validate-register.rb — VALIDATION OK (6 documents)
  • All six documents compile; caches populate for reachable endpoints
  • CI: verify the JCGM entries fetch-and-cache on the runner and the pages render them

Follow the metanorma.org authoring guidance (reference lookups: local
cache stores are portable directories meant to be committed to git for
reproducible, offline-tolerant CI builds): the documents compile with
:local-cache: (fetch when missing, persist) instead of
:local-cache-only:, and sources/*/relaton is committed.

Negative lookup markers (.notfound, .redirect) are gitignored - a
committed marker poisons the cache and silently drops the reference on
every future build - and the register validator fails on any that
appear. PM 1006's bare JCGM 101 anchor gains trailing text so it does
not render an empty citation chip.
@ronaldtse
ronaldtse merged commit 443624b into main Nov 5, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant