Add reusable CI/CD workflows for synchronized documentation #10

Activity

1. adrianbrowning

   added sub-issues on Aug 8, 2026

   • Provide a reusable CI script to check documentation synchronization #11
   • Provide a CI example for validating runnable Markdown snippets #12
   • Gate package releases on mdcode documentation and example checks #13
2. 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: Coordinate the independently delivered CI/CD examples into one complete mdcode adoption path.

   Current behavior:
   The initiative is already decomposed into a documentation-sync check (#11), runnable-example validation (#12), and release gating (#13). No parent-level implementation should duplicate those child deliverables.

   Desired behavior:
   After the child issues land, the repository presents one coherent, documented CI/CD path: consumers can check documentation drift, validate selected runnable snippets, and use the checks as release gates. The parent is complete only after the integrated path satisfies its acceptance criteria.

   Key interfaces:

   • Child deliverables — Provide a reusable CI script to check documentation synchronization #11, Provide a CI example for validating runnable Markdown snippets #12, and Gate package releases on mdcode documentation and example checks #13 remain the authoritative implementation work.
   • Integrated documentation path — connect the child examples so a consumer can discover and adopt them in sequence.
   • Release governance — publishing credentials, trusted publishing, and final release activation require maintainer control.

   Acceptance criteria:

   • Provide a reusable CI script to check documentation synchronization #11, Provide a CI example for validating runnable Markdown snippets #12, and Gate package releases on mdcode documentation and example checks #13 are complete and their examples remain independently usable.
   • The repository documents one end-to-end adoption path from drift checking through runnable validation and release gating.
   • The integrated path uses the current public CLI contract and canonical package identity.
   • The maintainer has reviewed and activated any required release credentials or trusted publishing configuration.

   Out of scope:

   • Reimplementing any child issue within this parent.
   • Adding CI providers beyond the documented example scope.
   • Changing mdcode command behavior.

   Why this needs a human:
   This is an integration and release-governance checkpoint. It requires coordinating completed child work and approving credentials/publishing policy rather than producing a separate code change.

   Verification status:
   Confirmed: the three required child deliverables already exist, and #13 depends on #11 and #12.
3. adrianbrowning

   added

   enhancementNew feature or requestNew feature or request

   ready-for-humanRequires human implementation or external-account decisionsRequires human implementation or external-account decisions

   on Aug 8, 2026
4. adrianbrowning

   marked this as blocked by 3 issues on Oct 4, 2026

   • Provide a reusable CI script to check documentation synchronization #11
   • Provide a CI example for validating runnable Markdown snippets #12
   • Gate package releases on mdcode documentation and example checks #13
5. adrianbrowning

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

   docs: one CI/CD path from drift check to gated release (#10) (#52)

   ...

   84e555b
6. adrianbrowning commented on Oct 6, 2026

   

   adrianbrowning

   on Oct 6, 2026

   OwnerAuthor

   More actions

   Done. The CI/CD path for consumers is in place:

   • Docs-sync check: Provide a reusable CI script to check documentation synchronization #11, examples/ci/check-docs-sync.mjs
   • Runnable-snippet validation: Provide a CI example for validating runnable Markdown snippets #12, examples/ci/validate-snippets.mjs
   • Release gating for this repo: Gate package releases on mdcode documentation and example checks #13, bumpy-release.yml and RELEASING.md. The first gated run on main, https://github.com/adrianbrowning/mdcode-ts/actions/runs/37467974745, passed every gate.
   • One end-to-end guide for consumers: docs: one CI/CD path from drift check to gated release (#10) #52, the "CI/CD Integration" section of the package README. It covers drift check, then runnable snippets, then a gated release using prepublishOnly or a GitHub Actions publish job.

   Two items stay with the maintainer, outside this issue: the canonical package name (#3, so the docs still say mdcode-ts for now) and configuring the npm trusted publisher.
7. adrianbrowning

   closed this as completedon Oct 6, 2026