Provide a reusable CI script to check documentation synchronization #11

Activity

1. adrianbrowning

   added a parent issue on Aug 8, 2026

   • Add reusable CI/CD workflows for synchronized documentation #10
2. adrianbrowning

   marked this as blocking on Aug 8, 2026

   • Gate package releases on mdcode documentation and example checks #13
3. adrianbrowning commented on Aug 8, 2026

   

   adrianbrowning

   on Aug 8, 2026

   OwnerAuthor

   More actions

   This was generated by AI during triage.

   Agent Brief

   Category: enhancement
   Summary: Provide a copyable CI and local-shell recipe that fails when linked Markdown code blocks drift from source files.

   Current behavior:
   The repository has no reusable consumer-facing drift-check script or GitHub Actions example. The existing update behavior does not yet offer the safe check contract needed for CI.

   Desired behavior:
   Consumers can copy one documented script, pass one or more Markdown documents, and run a non-mutating freshness check. The script reports each document with drift, exits successfully only when every selected document is synchronized, and works unchanged from a local shell or GitHub Actions job.

   Key interfaces:

   • Document inputs — accept one or more explicit Markdown paths and process each independently.
   • Check operation — use the public non-mutating update --check behavior from issue Add plan, diff, apply, and check workflows for agent-driven sync #6.
   • Exit behavior — success when no drift is found; non-zero drift result when one or more documents would change; operational failures remain distinguishable.
   • Actionable reporting — identify every out-of-sync document and preserve the underlying command diagnostics.
   • Consumer examples — provide both a local-shell invocation and a minimal GitHub Actions usage example.

   Acceptance criteria:

   • A documented, ready-to-copy script accepts one or more Markdown document paths.
   • It runs mdcode without modifying the documents.
   • It exits 0 only when every document is synchronized and returns a non-zero drift status otherwise.
   • It reports each document that is out of sync.
   • The same recipe is documented for local-shell and GitHub Actions use.
   • Tests cover synchronized, drifted, multi-document, and operational-failure cases.

   Out of scope:

   • Project-level configuration or glob discovery.
   • Runnable-example validation, which is issue Provide a CI example for validating runnable Markdown snippets #12.
   • Release publishing or credential configuration, which is issue Gate package releases on mdcode documentation and example checks #13.
   • Redefining the update/check contract, which is issue Add plan, diff, apply, and check workflows for agent-driven sync #6.

   Verification status:
   Confirmed: no existing GitHub Actions assets or reusable drift-check script exists. This issue is blocked by #6.
4. adrianbrowning

   added

   enhancementNew feature or requestNew feature or request

   ready-for-agentFully specified and ready for an AFK agentFully specified and ready for an AFK agent

   on Aug 8, 2026
5. adrianbrowning

   marked this as blocked on Oct 4, 2026

   • Add plan, diff, apply, and check workflows for agent-driven sync #6
6. adrianbrowning

   marked this as blocking on Oct 4, 2026

   • Add reusable CI/CD workflows for synchronized documentation #10
7. adrianbrowning

   added a commit that references this issue on Oct 4, 2026

   feat(ci): ready-to-copy script to check docs are in sync (#11) (#38)

   af33451
8. adrianbrowning

   closed this as completedin #38on Oct 4, 2026