Skip to content

Commit cb7f115

Browse files
committed
[README] Improve instructions on how to make releases
1 parent a7635ae commit cb7f115

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,10 +173,18 @@ Please see [LICENSE.md](LICENSE.md).
173173
## Releasing
174174
This section acts as a reminder of the few simple steps required to release a
175175
new version of the library. This is only relevant to Hana's developers. To
176-
release a new version of the library, create an annotated tag using `git tag -a`.
176+
release a new version of the library, make sure the current version in
177+
`include/boost/hana/version.hpp` matches the release you're about to publish.
178+
Then, create an annotated tag with:
179+
```sh
180+
git tag -a --file=- v<version> <<EOM
181+
...your message here...
182+
EOM
183+
```
184+
177185
Then, push the tag and create a new GitHub release pointing to that tag.
178186
Once that is done, bump the version number in `include/boost/hana/version.hpp`
179-
so that it matches the next planned release. Finally, do not forget to update
187+
so that it matches the next _planned_ release. Finally, do not forget to update
180188
the [Homebrew formula][] to point to the latest version.
181189
182190

0 commit comments

Comments
 (0)