From bf127dce2469ae8ebb4370ce6018d23012c18dc0 Mon Sep 17 00:00:00 2001 From: nea Date: Sun, 27 Aug 2023 17:55:51 +0200 Subject: Add documentation on how to do releases [no changelog] --- docs/How to release.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 docs/How to release.md diff --git a/docs/How to release.md b/docs/How to release.md new file mode 100644 index 0000000..862f382 --- /dev/null +++ b/docs/How to release.md @@ -0,0 +1,17 @@ + + +# How to create a release + +- Bump the version on gradle.properties +- Create a tag with that same version (without `v` prefix, please) +- Create a changelog based on + `git log --pretty=' - %s' --grep '[no changelog]' --invert-grep --fixed-strings oldversion..newversion | tac`, while + filtering out commits that should not be in the changelog. +- Upload to [GitHub](https://github.com/romangraef/Firmament/releases/new) +- Upload to [Modrinth](https://modrinth.com/mod/firmament/versions) +- Send a message in [Discord](https://discord.com/channels/1088154030628417616/1108565050693783683) +- Send a message in [the thread](https://hypixel.net/threads/firmament-a-skyblock-mod-for-1-20-1-fabric.5446366/) -- cgit