aboutsummaryrefslogtreecommitdiff
path: root/docs/How to release.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/How to release.md')
-rw-r--r--docs/How to release.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/How to release.md b/docs/How to release.md
index 862f382..d0d51d4 100644
--- a/docs/How to release.md
+++ b/docs/How to release.md
@@ -6,10 +6,12 @@ SPDX-License-Identifier: CC0-1.0
# How to create a release
+There is a release script to automate some of these actions.
+
- 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
+ `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)