Repository navigation
0004 changelog and versioning
github-actions[bot] edited this page Nov 18, 2026
·
1 revision
Status: accepted · Implementation: done · Date: 2026-11-18
From LibreLifts ADR 0017. How a version is chosen and which files carry it are spelled out here; LibreLifts left them open. Built 2026-11-18: CHANGELOG.md, the version 0.0.0 in package.json, and the rules in docs/workflow.md.
A commit message describes a change for the people who work on the code. Someone who uses LibreBars needs something else: what changed between one release and the next, and what a version number means. A changelog can be generated from commits, but commits are written for developers, and one change a person notices is often many commits.
-
Commit messages follow Conventional Commits 1.0.0:
<type>(<scope>): <description>. The types in use arefeat,fix,docs,chore,ci,refactorandtest. The scope is the app or package the commit changes (app,api,web,engine,ui,data,contracts), ordecisions, and is left out when the commit is about the repository as a whole. A breaking change takes!after the type and aBREAKING CHANGE:footer. -
One changelog,
CHANGELOG.mdat the root, in the Keep a Changelog 1.1.0 format. It is written by hand, for the people who use LibreBars. -
Changes are collected under
[Unreleased], grouped as Added, Changed, Deprecated, Removed, Fixed and Security. A commit that changes something a person using the product would notice adds its line in that same commit. -
Versions follow Semantic Versioning 2.0.0. The repository has
one version, carried by every
package.jsonand by the app's configuration, and they change together. It is0.0.0until the first release. -
The version is chosen at release time from the commits since the last release: a
featraises the minor number, and a release with only fixes raises the patch number. While the version is0.y.z, a breaking change raises the minor number too.1.0.0is the first release of the app in the stores. -
A release is one commit,
chore(release): X.Y.Z, that renames[Unreleased]to[X.Y.Z] - YYYY-MM-DD, updates the links at the foot of the changelog and sets the version.mainis then moved to it and tagged (0003).
- A commit has one more thing to do when it changes something a person would notice. Changes that only matter to developers stay out of the changelog.
- The changelog and the history can disagree. The pull request checklist is the reminder; nothing enforces it.
- One version covers the app, the website and the API. Releasing them separately would take a new record.
- Until
1.0.0anything may change between two releases.
Generated from docs/ on dev. Edit the docs there; changes made on the wiki are overwritten.
- Development
- Workflow
-
Decisions
- 0001 Decisions are recorded
- 0002 Apache License 2.0
- 0003 Changes land on dev by fast-forward; main is the last release
- 0004 Conventional Commits, Keep a Changelog and Semantic Versioning
- 0005 docs/ is for developers and is mirrored to the wiki
- 0006 LibreBars is a free workout log for calisthenics
- 0007 The tracker is an iOS and Android app; its web build stays until the store release
- 0008 LibreBars is an app and a crowd-sourced open database
- 0009 The database is ODbL, media is CC BY-SA, and neither can be closed later
- 0010 A hosted API with a free tier is the paid product
- 0011 The workspace is app, web and api, with engine, ui, data and contracts
- 0012 The engine is small pure functions, in the style of date-fns
- 0013 Web and app share a Tailwind theme, not components
- 0014 Postgres is the source of truth for all data
- 0015 The API is Fastify, and it owns LibreBars accounts
- 0016 Every install is a guest account, made in the background
- 0017 Accounts use Better Auth
- 0018 The on-device database is SQLite with Drizzle, on every platform
- 0019 Sync is our own push and pull
- 0020 The app says it backs up, and backup can be turned off
- 0021 Postgres 18, run with Docker Compose and tested on two databases
- 0022 expo-sqlite is patched so the web build reuses one buffer
- 0023 Seed data is TypeScript modules in packages/data, with permanent ids
- 0024 The first tables
- 0025 One TanStack Start app is the website, on GitHub Pages
- 0026 The catalog reaches the app as a snapshot plus updates, and the website through the API
- 0027 The app's first components are its own