Skip to content

Release v1.0.1

Choose a tag to compare

@github-actions github-actions released this 26 May 14:52
· 304 commits to main since this release

TopMark v1.0.1

First stable-line TopMark patch release.

This release focuses on targeted post-1.0 correctness fixes, documentation refinement, and stable-line maintenance while preserving the frozen 1.x CLI, configuration, public API, registry, pipeline, and machine-readable output contracts introduced in v1.0.0.

Highlights

  • Fixed unified diff rendering when pipeline views are pruned.
  • Fixed Markdown diff rendering for nested fenced code blocks.
  • Refined and reorganized the 1.0 documentation architecture.
  • Added dedicated getting-started and CI integration documentation.
  • Refreshed dependencies and pre-commit tooling.

Fixed

  • Fixed topmark check --diff and topmark strip --diff losing unified diff output when pipeline view pruning was enabled.
  • Fixed Markdown diff rendering when changed Markdown content itself contains triple-backtick or longer fenced code blocks.
  • Added regression coverage for diff output preservation and Markdown fence collision handling.

Documentation

  • Added:
    • docs/usage/getting-started.md
    • docs/usage/ci.md
  • Improved README quick-start guidance and product positioning.
  • Refined installation and contribution documentation.
  • Improved configuration, pipeline, architecture, and command-reference documentation.
  • Updated MkDocs navigation and documentation structure.
  • Moved machine-output documentation from:
    • docs/dev/machine-output.md
    • to docs/usage/machine-output.md

Internal

  • Simplified internal pipeline selection logic.
  • Clarified internal pipeline view-pruning naming.
  • Updated machine-output tests to match output-contract wording and documentation refinements.
  • Refreshed locked dependencies including click, ruff, and uv.
  • Updated pre-commit dependencies, including TopMark itself.

Notes

This release intentionally remains narrow in scope and compatible with the stable 1.x maintenance posture.

Larger post-1.0 architecture work remains explicitly deferred, including:

  • evaluating rich-click;
  • replacing yachalk with rich;
  • generated command-help documentation;
  • Markdown presentation refactoring;
  • and future streaming pipeline architecture exploration.

What's Changed (PRs only):

  • fix(pipeline): preserve diff output when pruning pipeline views by @shutterfreak in #57
  • fix(markdown): render diffs with collision-safe code fences by @shutterfreak in #58
  • build(deps): bump ruff from 0.15.13 to 0.15.14 by @dependabot[bot] in #53
  • build(deps): bump click from 8.4.0 to 8.4.1 by @dependabot[bot] in #54
  • build(deps): bump uv from 0.11.15 to 0.11.16 by @dependabot[bot] in #55

Full Changelog: v1.0.0...v1.0.1