summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSami Kerola <kerolasa@iki.fi>2019-05-17 18:21:36 +0100
committerSami Kerola <kerolasa@iki.fi>2019-05-17 18:21:36 +0100
commit18bf757af41139cefb5617c5af59be38a5496d38 (patch)
tree54d314a078f4a55e57de8dbdcdce4d062b388c7e
parent1cbec29f8e894967394b1d0a66f57260f70ecef9 (diff)
downloadiputils-18bf757af41139cefb5617c5af59be38a5496d38.tar.gz
docs: add release instructions
Write using shell history after s20190515 release that I did on top of memory, and incorrectly. Reference: https://github.com/iputils/iputils/issues/179 Signed-off-by: Sami Kerola <kerolasa@iki.fi>
-rw-r--r--Documentation/README.maintainer35
1 files changed, 35 insertions, 0 deletions
diff --git a/Documentation/README.maintainer b/Documentation/README.maintainer
index 2ce93bc..1aaf688 100644
--- a/Documentation/README.maintainer
+++ b/Documentation/README.maintainer
@@ -24,3 +24,38 @@ report. Links to reference materials can also be useful when in future
trying to understand why something was done. It is also nice when commit id
of the change that caused a bug is referred in commit message. That helps
understanding what versions are impacted by an issue.
+
+# How to make a release
+
+Go to release listings https://github.com/iputils/iputils/releases and check
+what was said in previous release message. Draft release message - remember
+if you have nothing to say then you don't have good enough reason to publish
+release.
+
+Create release commit and tag.
+
+ date_str=$(date +s%Y%m%d) &&
+ sed --in-place "s/version : '.*')/version : '$date_str')/" meson.build &&
+ git add meson.build &&
+ git commit --signoff --message "release: iputils-$date_str" &&
+ git tag --sign --annotate $date_str --message iputils-$date_str
+
+Check that the commit and tag looks ok.
+
+ git show $date_str --show-signature
+
+Assuming things are great push to github.
+
+ git push origin master:master &&
+ git push origin --tags
+
+Go to github https://github.com/iputils/iputils/releases and paste the
+release message you drafted earlier to text box. Choose the tag you just
+created. Download the release files and sign them.
+
+ for file in iputils-$date_str ; do gpg --sign --armor --detach-sign $file ; done
+
+Upload the .asc files to release as additional files. The release should be
+ready. People tend to react to releases, so expect bug reports and pull
+requests after release. Assuming release has fatal flaw(s) make another one
+sometime soon.