Skip to content

DiagramPilot v0.2.8

Choose a tag to compare

View all tags
@github-actions github-actions released this 08 Jun 13:59
v0.2.8
9bff9b3
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

DiagramPilot v0.2.8

Issue: Generated Markdown embeds
Issue Version: 0.2.8
Tag: v0.2.8
npm: https://www.npmjs.com/package/diagrampilot/v/0.2.8
Public Website: https://diagrampilot.com

Summary

Add generated Markdown embeds as standalone generated files. DiagramPilot
should not edit arbitrary prose documents in place. Configured Markdown embeds
should depend on the freshness of referenced artifacts, so a clean embed cannot
hide a stale diagram image or export.

Implementation Notes

  • Added configured format: markdown support as standalone generated embed
    files, written after referenced artifacts and included in generate write
    results.
  • Markdown embeds render a generated header, source title, a primary SVG/PNG
    image reference, and links to additional configured Mermaid, D2, DOT, or PNG
    artifacts with paths relative to the embed file.
  • check now compares Markdown embed content and reports the embed stale when a
    referenced configured artifact is missing, unreadable, unchecked, or stale.
  • generate does not edit arbitrary prose documents in place; smoke coverage
    verifies an existing docs/guide.md remains unchanged.
  • Updated public docs and installation cleanup guidance to describe standalone
    Markdown embed artifacts.
  • Completed a Fallow cleanup pass around changed code: split configured artifact
    path and Markdown freshness helpers out of the main checker, shared source
    loading/path helpers between check and generate, reduced CLI parser/planner
    duplication, and kept authored files under the 500 LOC maintainability gate.
  • Added issue-driven release version sync and validation tooling so closeout can
    derive shared package metadata from the local issue's Issue Version, refresh
    version-sensitive generated artifacts, and fail CI when completed issue
    version metadata drifts from package metadata.
  • Required Fallow gates pass with no introduced findings. A no-baseline snapshot
    still shows inherited baseline debt, but this issue reduced it to 0 dead-code
    issues, 80 health findings, and 115 duplicate groups.

Validation Results

  • npm test passed: 218 tests.
  • npm run audit:fallow passed.
  • npm run audit:fallow:changed passed.
  • npm run sync:issue-release-version -- --issue .scratch/v0-3-0-alpha-capability-release/issues/71-generated-markdown-embeds.md
    passed and idempotently synced release metadata, built the workspace,
    refreshed the checkout demo SVG, and checked the demo artifact.
  • npm run check:release-version -- 0.2.8 passed.
  • npm run check:issue-release-version -- --issue .scratch/v0-3-0-alpha-capability-release/issues/71-generated-markdown-embeds.md
    passed.
  • npm run check:package-readiness passed for 7 public packages.
  • node scripts/generate-release-notes.mjs --version 0.2.8 --tag v0.2.8
    generated a non-empty release draft body.
  • Release metadata was bumped to the assigned Issue Version 0.2.8, and the
    checkout demo SVG provenance was refreshed at 0.2.8.
  • npm view diagrampilot@0.2.8 version dist-tags --json --registry=https://registry.npmjs.org/
    returned npm E404, confirming 0.2.8 is not already published.
  • git ls-remote --tags origin refs/tags/v0.2.8 returned no tag.
  • gh release view v0.2.8 --repo StiensWout/DiagramPilot returned no release.
  • node packages/cli/dist/index.js check demo-projects/checkout --json passed
    with ok: true, 1 checked source, 1 fresh source, and 0 issues.
  • git diff --check passed.
Assets 2
Loading