chore(release): v0.1.0 changelog + README pre-tag fixes #131

Merged
lerko merged 3 commits from chore/v010-readme-changelog into main 2026-06-12 23:45:19 +00:00
Owner

Last pre-tag chore before v0.1.0.

README

  • Quick start was broken: go run cmd/uptop/main.go fails with undefined: parseConfig since #108 split config.go out of main.go — switched to go run ./cmd/uptop (same fix #104 applied to Dockerfile/goreleaser)
  • Binary install section claimed Linux amd64 only; #104 ships linux/darwin/windows x amd64/arm64 + deb/rpm
  • Canonical-origin line added (Gitea canonical, GitHub mirror) — adoption-blocker from the fresh-eyes review
  • First-run docs now point only at UPTOP_ADMIN_KEY

cliff.toml

  • Removed body = ".*security" parser: first-match ordering meant it only ever caught non-security commits that mention the word in their body (docs commit + the CalVer→SemVer ci commit rendered under a public Security heading). Real security fixes are caught by ^fix first.
  • polish type mapped to Changed (was rendering a stray lowercase "polish" section)

CHANGELOG.md

  • Regenerated full history simulated against v0.1.0 — replaces the stale CalVer changelog whose referenced tags were all deleted. Verified locally: Added/Changed/Fixed sections only, matches what release-binaries.yml will publish.
Last pre-tag chore before v0.1.0. **README** - Quick start was broken: `go run cmd/uptop/main.go` fails with `undefined: parseConfig` since #108 split config.go out of main.go — switched to `go run ./cmd/uptop` (same fix #104 applied to Dockerfile/goreleaser) - Binary install section claimed Linux amd64 only; #104 ships linux/darwin/windows x amd64/arm64 + deb/rpm - Canonical-origin line added (Gitea canonical, GitHub mirror) — adoption-blocker from the fresh-eyes review - First-run docs now point only at UPTOP_ADMIN_KEY **cliff.toml** - Removed `body = ".*security"` parser: first-match ordering meant it only ever caught non-security commits that mention the word in their body (docs commit + the CalVer→SemVer ci commit rendered under a public Security heading). Real security fixes are caught by `^fix` first. - `polish` type mapped to Changed (was rendering a stray lowercase "polish" section) **CHANGELOG.md** - Regenerated full history simulated against v0.1.0 — replaces the stale CalVer changelog whose referenced tags were all deleted. Verified locally: Added/Changed/Fixed sections only, matches what release-binaries.yml will publish.
lerko added 3 commits 2026-06-12 23:39:10 +00:00
- go run cmd/uptop/main.go broke when PR #108 split config.go out of
  main.go — use ./cmd/uptop package path (same fix #104 applied to
  Dockerfile and goreleaser)
- binary section claimed Linux amd64 only; goreleaser ships
  linux/darwin/windows x amd64/arm64 + deb/rpm since #104
- state canonical repo (Gitea) vs mirror (GitHub) up front
- UPTOP_ADMIN_KEY is the only documented first-run path
The body=".*security" parser ran before the docs/chore skip rules, so
any commit merely mentioning security in its body landed in the
Security section (e.g. a docs commit and the CalVer->SemVer ci commit).
Real security fixes never reached it — ^fix matches first — so the rule
only ever produced miscategorized entries. Removed.

polish(...) commits had no parser, and git-cliff defaults the group to
the raw type — rendering a stray lowercase "polish" section. Mapped to
Changed.
docs(changelog): regenerate full history for v0.1.0
CI / test (pull_request) Successful in 1m44s
CI / lint (pull_request) Successful in 1m6s
CI / vulncheck (pull_request) Successful in 57s
de51dde6e6
Replaces the stale CalVer changelog (last updated 2026-06-02, all
referenced tags since deleted) with git-cliff output simulated against
the v0.1.0 tag — matches what release-binaries.yml will publish as
release notes.
lerko merged commit de51dde6e6 into main 2026-06-12 23:45:19 +00:00
lerko deleted branch chore/v010-readme-changelog 2026-06-12 23:45:20 +00:00
Sign in to join this conversation.
No Reviewers
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: lerkolabs/uptop#131