Repository navigation
Add reusable CI/CD workflows for synchronized documentation #10
Description
Activity
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.- added a commit that references this issue
on Oct 6, 2026 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.ymland 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
prepublishOnlyor 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-tsfor now) and configuring the npm trusted publisher.- Docs-sync check: Provide a reusable CI script to check documentation synchronization #11,
What to build
Make mdcode practical to adopt in CI/CD pipelines by providing a reusable documentation-synchronization check, runnable-example validation, and release gating. A consumer should be able to copy the examples and prevent stale Markdown code blocks from reaching production.
Acceptance criteria
Blocked by