Skip to content

Commit f4352a3

Browse files
committed
two docs described the sync and the release as they were an hour ago
README's verb list still said `kuma sync` converges, which stopped being the whole story when both syncs lost their argument list. `--help` and concepts.md were updated with that change; the one-line summary a reader skims first was not. CONTRIBUTING's release steps omitted the lock. Cargo.lock records the workspace member's own version, so bumping Cargo.toml alone leaves the two disagreeing and every `--locked` call fails, which is most of CI. That is not a hypothetical: it happened on the v0.3.0 bump and only a local rehearsal caught it before the push. The example version moves to v0.4.0 too, since quoting the release that already exists reads like a record rather than an instruction. Deliberately not changed: the `kuma diff` transcript in concepts.md still reads "converge now; otherwise the boot/daily run picks this up", because that is inspect.rs:365 verbatim. Editing the doc alone would make it misquote real output, and the affordance is contextual advice about resolving the drift on screen rather than a description of everything sync does.
1 parent 70612bf commit f4352a3

2 files changed

Lines changed: 13 additions & 7 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,22 @@ A separate job runs `cargo audit` against the committed `Cargo.lock`, on every
2929
push and again weekly, because a dependency becomes vulnerable when the
3030
advisory lands rather than when someone next touches the tree.
3131

32-
**Cutting a release.** Bump `version` in `Cargo.toml`, commit it, then tag:
32+
**Cutting a release.** Bump `version` in `Cargo.toml`, refresh the lock,
33+
commit both, then tag:
3334

3435
```console
35-
$ git tag -a v0.3.0 -m "kuma v0.3.0"
36-
$ git push origin v0.3.0
36+
$ cargo update -p kuma --offline # Cargo.lock records kuma's own version
37+
$ git tag -a v0.4.0 -m "kuma v0.4.0"
38+
$ git push origin v0.4.0
3739
```
3840

39-
The tag and `Cargo.toml` have to agree. The release workflow checks and
40-
fails rather than publishing a binary whose own `--version` contradicts the
41-
release it sits in.
41+
`Cargo.lock` is not optional here. It carries the workspace member's version
42+
too, so bumping only `Cargo.toml` leaves the lock disagreeing and every
43+
`--locked` call fails, which is most of CI.
44+
45+
The tag and `Cargo.toml` have to agree as well. The release workflow checks
46+
and fails rather than publishing a binary whose own `--version` contradicts
47+
the release it sits in.
4248

4349
Push to `main` first and let it go green. A push that touches anything
4450
other than documentation refreshes the rolling `latest` prerelease, and it

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ $ kuma capture # declare what this machine already r
141141
$ kuma check # validate the declaration, build nothing
142142
$ kuma diff # drift: kuma.toml vs image vs machine
143143
$ kuma doctor # machine health, /etc drift, snapshots, GPU, disk
144-
$ kuma sync # converge flatpaks and brew now
144+
$ kuma sync # converge, and update everything installed
145145
$ kuma snapshot # the btrfs snapshots this machine has taken
146146
$ kuma snapshot --restore ~/notes.md # bring a path back (dry run; --yes writes)
147147
$ kuma update --check # has the locked base moved?

0 commit comments

Comments
 (0)