diff options
| author | nea <nea@nea.moe> | 2023-08-27 17:55:51 +0200 |
|---|---|---|
| committer | nea <nea@nea.moe> | 2023-08-27 17:55:51 +0200 |
| commit | bf127dce2469ae8ebb4370ce6018d23012c18dc0 (patch) | |
| tree | 4ae2e3a9a6623e5b5f0d9119aa593f1a0ecf513c | |
| parent | 5473ac25feecef53c0cfcd49d37a17fb3058d23f (diff) | |
| download | Firmament-bf127dce2469ae8ebb4370ce6018d23012c18dc0.tar.gz Firmament-bf127dce2469ae8ebb4370ce6018d23012c18dc0.tar.bz2 Firmament-bf127dce2469ae8ebb4370ce6018d23012c18dc0.zip | |
Add documentation on how to do releases
[no changelog]
| -rw-r--r-- | docs/How to release.md | 17 |
1 files changed, 17 insertions, 0 deletions
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 @@ +<!-- +SPDX-FileCopyrightText: 2023 Linnea Gräf <nea@nea.moe> + +SPDX-License-Identifier: CC0-1.0 +--> + +# 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/) |