Skip to content

DiagramPilot v0.2.4

Choose a tag to compare

View all tags
@github-actions github-actions released this 07 Jun 09:04
v0.2.4
429d815
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.4

Issue: YAML-only source support
Issue Version: 0.2.4
Tag: v0.2.4
npm: https://www.npmjs.com/package/diagrampilot/v/0.2.4
Public Website: https://diagrampilot.com

Summary

Remove *.dp.json as a DiagramPilot Source File format for v0.3.0. YAML stays
the only Authoring Format. JSON remains valid for structured CLI output,
DiagramSpec JSON Schema, SVG provenance metadata, package manifests, and other
tooling surfaces.

When users explicitly pass old JSON source files, commands should fail with a
repairable diagnostic that points them to YAML source files. Do not add a
JSON-to-YAML migration command in this issue.

Implementation Notes

  • Removed *.dp.json from recursive DiagramPilot Source File discovery. Directory
    scans now discover *.dp.yaml only, while explicit .dp.json check scopes
    fail with a YAML-oriented repair hint instead of silently passing.
  • Added an unsupported-source-format source-loading failure for explicit
    legacy JSON source paths. validate, export, and render now reject
    *.dp.json before JSON parsing and point users to *.dp.yaml.
  • Preserved structured --json command output. Added focused command-planning
    coverage for successful YAML validation JSON output and legacy JSON-source
    repair hints in JSON output.
  • Preserved non-source JSON surfaces: DiagramSpec JSON Schema tests, SVG
    provenance JSON tests, and package manifest readiness tests continue to pass.
  • Did not add a JSON-to-YAML migration command.
  • Updated public docs, README.md, llms.txt, init-generated local guidance,
    maintainer docs, and the v0.3.0 PRD to present YAML-only source support and
    distinguish source removal from JSON tooling compatibility.
  • Release-note callout: DiagramPilot 0.2.4 removes *.dp.json as a
    DiagramPilot Source File format. Convert legacy JSON sources to *.dp.yaml;
    JSON remains supported for CLI --json output, DiagramSpec JSON Schema, SVG
    provenance metadata, package manifests, and other tooling surfaces.
  • Bumped shared DiagramPilot release metadata to Issue Version 0.2.4 and
    refreshed checkout demo SVG provenance at 0.2.4.

Validation Results

  • node scripts/bump-release-version.mjs 0.2.4 passed.
  • npm run build passed.
  • cd demo-projects/checkout && node ../../packages/cli/dist/index.js render docs/architecture.dp.yaml --out docs/architecture.svg
    passed.
  • cd demo-projects/checkout && node ../../packages/cli/dist/index.js check
    passed: 1 DiagramPilot Source File fresh.
  • node --test --test-concurrency=1 test/repo-workflow-source-discovery.test.mjs
    passed: 6 tests.
  • node --test --test-concurrency=1 test/validated-diagramspec-loading.test.mjs
    passed: 6 tests.
  • node --test --test-concurrency=1 test/cli-smoke.test.mjs
    passed: 15 tests.
  • node --test --test-concurrency=1 test/cli-command-planning.test.mjs
    passed: 28 tests.
  • node --test --test-concurrency=1 test/cli-validate-json-output.test.mjs
    passed: 2 tests.
  • node --test --test-concurrency=1 test/diagramspec-json-schema.test.mjs test/render-svg-provenance.test.mjs test/package-readiness.test.mjs
    passed: 11 tests.
  • node --test --test-concurrency=1 test/docs-public-boundary.test.mjs
    passed: 18 tests.
  • node --test --test-concurrency=1 test/cli-command-planning.test.mjs test/cli-validate-json-output.test.mjs test/documentation-contract.test.mjs test/maintainability-file-size-gate.test.mjs
    passed: 41 tests.
  • npm test passed: 183 tests.
  • node packages/cli/dist/index.js validate demo-projects/checkout/docs/architecture.dp.yaml
    passed.
  • node scripts/check-release-version.mjs passed at 0.2.4.
  • node scripts/generate-release-notes.mjs --version 0.2.4 --tag v0.2.4
    passed and generated release notes that call out JSON source removal.
  • git diff --check passed.

User-Facing Docs Links

Known Limitations

  • No JSON-to-YAML migration command was added. Convert legacy source files to
    *.dp.yaml manually or with project-owned tooling.

Follow-Up

  • None.
Assets 2
Loading