23 lines
2.3 KiB
Markdown
23 lines
2.3 KiB
Markdown
# Committing and Releasing
|
|
|
|
The commit convention and the version bump that goes with it.
|
|
|
|
## Git Workflow
|
|
- Commit format: `([ticketID]) [short description]`
|
|
- Use `--fixup` for incremental changes
|
|
- Test before moving to reviewing status
|
|
|
|
## Version Bumps
|
|
- Before every commit, decide whether the change warrants a version bump in `Cargo.toml`
|
|
- Always ask the user to confirm the bump and its kind before making it — never bump silently, and never skip the question because the answer looks obvious
|
|
- **`make patch`, `make minor` and `make major` do the mechanics**, run after the commit is in: each bumps `Cargo.toml` and the `worklane` entry in `Cargo.lock`, appends `, and bump to <version>` to the commit's subject, folds the bump into that commit, and tags it. Bumping by hand is how a version comes to be left untagged, which is what the one action is for. It refuses on a dirty tree, on an already-tagged `HEAD` and on a `HEAD` that is already pushed, since each of those makes the amend lose work, orphan a tag or need a force push
|
|
- Pre-1.0, so: patch for fixes and internal changes, minor for a new command, flag or changed output, major only for a deliberate 1.0
|
|
- **Changed output means the CLI's output.** That is the surface scripts and agents read, so a changed listing, message or exit code is a minor. A change to what the board draws is a patch however visible it is, since nothing consumes the frame. See [The Board View](tui-board.md)
|
|
- **Settling output that shipped one version ago is a patch**, not a second minor. 0.15.1 changed the relation mark 0.15.0 had just introduced, and 0.15.2 added the status mark beside it: the minor was the arrival of a marked relations block, and settling what it marks belongs to that. Three minors in an hour would tell anyone reading the tags that there were three features
|
|
- No bump for docs-only, tests-only or `--fixup` commits
|
|
- When one body of work spans several commits, bump once on the final commit rather than on each
|
|
- Every bump gets a matching annotated tag, `v<version>`, on the bump commit — a bumped version is never left untagged
|
|
- Tag locally only; never push a tag unless asked
|
|
- `worklane --version` reports the crate version alongside the build sha, so the bump is what makes one release distinguishable from another
|
|
|