Skip to content

Release 1.0.0b1

Pre-release
Pre-release

Choose a tag to compare

@shutterfreak shutterfreak released this 11 May 23:26
· 410 commits to main since this release

TopMark 1.0.0b1

First 1.0 beta release focused on validating the frozen 1.0 contracts after the alpha stabilization series.

This release finalizes beta-facing documentation, CLI/help wording, shared-option terminology, machine-readable output wording, and config/runtime snapshot behavior.

Highlights

  • Transitioned the 1.0 line from alpha contract stabilization to beta validation.
  • Fixed config output snapshots so TOML-authored runtime sections such as [writer] are preserved.
  • Added typed synthetic config provenance for built-in, bundled, CLI/API, and non-filesystem config sources.
  • Aligned config defaults and config init behavior across text, Markdown, JSON, and NDJSON output.
  • Finalized shared-option terminology, replacing older “global options” wording in user-facing docs.
  • Harmonized “machine-readable output” terminology across docs, source docstrings, and tests.
  • Removed remaining transitional CLI-state scaffolding and finalized typed CLI state behavior.
  • Recorded post-1.0 deferrals such as in-memory pipeline support, Rich migration, registry query commands, and explicit TOML schema versioning.

Breaking changes

  • Config machine-readable payloads may now include TOML-authored runtime sections such as [writer].
  • Synthetic config provenance is now typed and rendered as stable labels such as <defaults> and <built-in topmark defaults>.
  • config init machine-readable output now represents the bundled starter template rather than a shortcut through built-in defaults.
  • CLI and documentation terminology changed for shared options and machine-readable output.

Install from TestPyPI

python -m pip install \
  --index-url https://test.pypi.org/simple/ \
  --extra-index-url https://pypi.org/simple/ \
  topmark==1.0.0b1

See CHANGELOG.md for the full release notes.