Skip to content

State the 0.x versioning rule and cut the 0.2.0 changelog #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
sehkone wants to merge 1 commit into from
+12 −1
Closed

State the 0.x versioning rule and cut the 0.2.0 changelog #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Keep a Changelog change-type headings, so a consumer reads only the
sections that affect its template. Version numbers follow the
`MAJOR.MINOR.PATCH` policy described in [the README](README.md#versioning).

## Unreleased
## [0.2.0] - 2026-08-08

### manual

Expand Down Expand Up @@ -112,4 +112,5 @@ sections that affect its template. Version numbers follow the
- Added release workflow to create GitHub Releases from tags using
CHANGELOG.md.

[0.2.0]: https://github.com/aicers/docs-theme/tree/0.2.0
[0.1.0]: https://github.com/aicers/docs-theme/tree/0.1.0
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,16 @@ Templates are **not** versioned separately: one repository version covers
all of them, and the vendored diff in a consumer's bump pull request
shows whether that consumer is actually affected.

While the version is below `1.0.0`, a breaking change bumps MINOR rather
than MAJOR, and everything else bumps PATCH. The project stays on `0.x`
until the contract above — the install layout, `docs/theme.toml`,
`docs/theme/.meta`, the inherited `mkdocs-base.yml`, the `extra.pdf`
block, and the `build-docs-pdf.sh` interface — has been proven by
consumers actually adopting it. Until then a breaking change is expected
often enough that spending MAJOR on one would drain the signal MAJOR is
meant to carry. `1.0.0` is the point at which "this defines the public
API" describes what happened rather than what is intended.

A release is only meaningful when the installed surface actually changed.
The release workflow rejects a tag whose release surface — everything
`fetch-theme.sh` installs, plus `fetch-theme.sh` itself — is byte-identical
Expand Down