From 5382ce867b0e111ec8ecc9f5a84d6c2df5ce13a5 Mon Sep 17 00:00:00 2001 From: Ben Kochie Date: Tue, 2 Jun 2020 14:18:40 +0200 Subject: [PATCH] Update RELEASE doc * Simplify tag snipit slightly. * Add a git alias helper. Signed-off-by: Ben Kochie --- RELEASE.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index fce8c5d3a..31148b6c8 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -103,11 +103,20 @@ Entries in the `CHANGELOG.md` are meant to be in this order: Tag the new release via the following commands: ```bash -$ tag=$(< VERSION) -$ git tag -s "v${tag}" -m "v${tag}" -$ git push origin "v${tag}" +$ tag="v$(< VERSION)" +$ git tag -s "${tag}" -m "${tag}" +$ git push origin "${tag}" ``` +Optionally, you can use this handy `.gitconfig` alias. + +```ini +[alias] + tag-release = "!f() { tag=v${1:-$(cat VERSION)} ; git tag -s ${tag} -m ${tag} && git push origin ${tag}; }; f" +``` + +Then release with `git tag-release`. + Signing a tag with a GPG key is appreciated, but in case you can't add a GPG key to your Github account using the following [procedure](https://help.github.com/articles/generating-a-gpg-key/), you can replace the `-s` flag by `-a` flag of the `git tag` command to only annotate the tag without signing. Once a tag is created, the release process through CircleCI will be triggered for this tag and Circle CI will draft the GitHub release using the `prombot` account.