Skip to content

Commit 85611d1

Browse files
authored
Merge pull request #318 from SwissDataScienceCenter/docs/release-version-bump
docs(releasing): name the bump default, and how to undo one
2 parents 591feb7 + 06e90e4 commit 85611d1

1 file changed

Lines changed: 14 additions & 1 deletion

File tree

‎RELEASING.md‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ From an up-to-date, clean `main`:
117117

118118
```bash
119119
just version::check # the versions already agree
120-
just version::bump minor # or patch / major
120+
just version::bump minor # patch / minor / major — always say which
121121
git show # read the release commit before it leaves
122122
git push && git push origin v0.9.0
123123
```
@@ -127,10 +127,23 @@ commits as `chore(release): v0.9.0` and creates the annotated tag. It pushes
127127
nothing — it prints the two `git push` commands so the release is never a side
128128
effect of running it.
129129

130+
Name the bump every time. With no argument `bump` defaults to a `patch` and the
131+
first place it tells you which one it chose is the commit it has already made.
132+
130133
Pushing the tag builds and pushes `release/backend-service:0.9.0` and
131134
`release/frontend-service:0.9.0`. A release image is never overwritten, so a
132135
botched tag is fixed by bumping again, not by re-tagging.
133136

137+
### If you bumped the wrong way
138+
139+
`bump` commits and tags locally and pushes nothing, so a release you have not
140+
pushed yet is thrown away without anybody else learning of it:
141+
142+
```bash
143+
git reset --hard origin/main
144+
git tag -d v0.9.0
145+
```
146+
134147
If `main` has moved past something you cannot ship and a released version needs
135148
a fix, branch from the tag rather than from `main`:
136149

0 commit comments

Comments
 (0)