diff --git a/CHANGELOG-TEMPLATE.md b/CHANGELOG-TEMPLATE.md new file mode 100644 index 00000000..8662681f --- /dev/null +++ b/CHANGELOG-TEMPLATE.md @@ -0,0 +1,8 @@ +# vX.Y.Z (rXXX) +## TL;DR +- N/A + +## Full Changelog +- N/A (latest commit to oldest commit) + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ee8dbb6..ff2600ec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,18 +9,18 @@ See [BUILDING.md](./BUILDING.md) for more information ## Release process 1. Update the changelog - 1. Copy the content of the template changelog to the top of the actual changelog - 2. Create the changelog since the latest release (printed in console) with `npm run createChangelog -- --sha ` + 1. Copy the content of the [template changelog](CHANGELOG-TEMPLATE.md) to the top of the actual changelog + 2. Create the changelog for the new release with `npm run createChangelog -- --sha ` (printed in console) 3. Copy the changelog to the corresponding position in the template 4. Create a TL;DR 2. Update the [version to server version mapping file](versionToServerVersionMapping.json) - 1. See [When to update](#when-to-update) + 1. See [wWen to update](#when-to-update) -## WebUI to [server](https://github.com/Suwayomi/Tachidesk-Server) mapping +## WebUI to [Server](https://github.com/Suwayomi/Tachidesk-Server) mapping ### Explanation For the server to be able to automatically download the latest compatible WebUI version, the [version to server version mapping file](versionToServerVersionMapping.json) has to be provided.
-The order of the version mapping is important and has to be sorted by oldest WebUI version to latest version.
+The order of the version mapping is important and has to be sorted by latest WebUI version to the oldest version.
The latest version will always be `PREVIEW`. ### When to update