Release Channels
This page describes the release contract, official installation channels, and artifacts generated by the release workflow.
Release Contract
Section titled “Release Contract”cmakefmt is past 1.0. The CLI, configuration schema, and Rust library API
follow the stability contract. Bug fixes may change incorrect
formatting output; new formatting styles use opt-in settings or documented
default changes. Pin an exact version when reproducible formatting is required.
Support Levels
Section titled “Support Levels”cmakefmt distinguishes between channels that are part of the core release
contract and community or planned channels. See Installation
for the full channel list and setup instructions.
| Channel | Support level | What to expect |
|---|---|---|
| GitHub Releases binaries | Officially maintained | Release artifacts and checksums published for supported platforms. |
cargo install cmakefmt-rust |
Officially maintained | Curated crates.io package with the same source tree used for releases. |
| Documentation site | Officially maintained | Updated as part of the tagged release. |
Homebrew / winget / PyPI wheels |
Officially maintained | Package-manager installs of the formatter. |
| Scoop | Planned | Manifest maintained in the repository; see Installation for availability. |
| Additional package managers / wrappers | Best effort | Useful distribution channels, but not all are release blockers. |
Release Artifacts
Section titled “Release Artifacts”Each tagged release is expected to ship:
cmakefmtbinaries for supported platformsSHA256SUMS- a curated source package on crates.io
- release notes with installation examples
- shell completions generated from the same CLI metadata as
--help - a generated man page for packagers and Unix-like installs
- the dprint WASM plugin and its configuration schema
You can preview the packaging helper outputs from a local build:
cmakefmt completions bash > cmakefmt.bashcmakefmt completions zsh > _cmakefmtcmakefmt manpage > cmakefmt.1Version Output
Section titled “Version Output”cmakefmt --version reports the package version, and local development builds
also include a short Git commit when available.
That keeps local binaries identifiable without forcing Git metadata into published release packages.
Stability Across Releases
Section titled “Stability Across Releases”Bug fixes and documented default changes can affect output when you upgrade.
Review the changelog and stability contract, then
run cmakefmt --check . with the new version before updating CI pins.
Release notes and support policy updates are published with each tagged release.
Docs track main. For historical docs, check out a release tag inthe repository and builddocs/ locally.
