create changelog script

changelogs/templates/announcements.md

@@ -0,0 +1,8 @@
+- Automated API Documentation Updates recently implemented
+- At long last, a new Lidarr `develop` / beta release
+- ** Known Issues **
+  - Linux users map experience errors such as:
+    - `You have an old version of fpcalc. Please upgrade to 1.4.3.`
+    - `An error occurred trying to start process '/opt/Lidarr/fpcalc' with working directory '/'. Permission denied`
+  - A fix will be out soon, but this can be fixed by setting fpcalc to be executable `chmod +x /opt/Lidarr/fpcalc`
+  - Note that for the fix `sudo` may be required or your path to Lidarr's binary folder may be different depending on your environment and setup.

changelogs/templates/branch-develop.md

@@ -0,0 +1,6 @@
+- **Users who do not wish to be on the alpha `nightly` testing branch should take advantage of this parity and switch to `develop`**
+
+A reminder about the `develop` and `nightly` branches
+
+- **develop** - Current Develop/Beta - (Beta): This is the testing edge. Released after tested in nightly to ensure no immediate issues. New features and bug fixes released here first after nightly. It can be considered semi-stable, but is still beta.
+- **nightly** - Current Nightly/Unstable - (Alpha/Unstable) : This is the bleeding edge. It is released as soon as code is committed and passes all automated tests. This build may have not been used by us or other users yet. There is no guarantee that it will even run in some cases. This branch is only recommended for advanced users. Issues and self investigation are expected in this branch. Use this branch only if you know what you are doing and are willing to get your hands dirty to recover a failed update. This version is updated immediately.

changelogs/templates/branch-master.md

@@ -0,0 +1,6 @@
+- **Users who do not wish to be on the alpha `nightly` or beta `develop` testing branches should take advantage of this parity and switch to `master`**
+
+A reminder about the `develop` and `nightly` branches
+
+- **develop** - Current Develop/Beta - (Beta): This is the testing edge. Released after tested in nightly to ensure no immediate issues. New features and bug fixes released here first after nightly. It can be considered semi-stable, but is still beta.
+- **nightly** - Current Nightly/Unstable - (Alpha/Unstable) : This is the bleeding edge. It is released as soon as code is committed and passes all automated tests. This build may have not been used by us or other users yet. There is no guarantee that it will even run in some cases. This branch is only recommended for advanced users. Issues and self investigation are expected in this branch. Use this branch only if you know what you are doing and are willing to get your hands dirty to recover a failed update. This version is updated immediately.

changelogs/templates/commentary.md

@@ -0,0 +1,6 @@
+- [Lidarr](https://lidarr.audio/donate), [Prowlarr](https://prowlarr.com/donate), [Radarr](https://radarr.video/donate), [Readarr](https://readarr.com/donate) now accept direct bitcoin donations
+- [Readarr official beta on `develop` announced](https://www.reddit.com/r/Readarr/comments/sxvj8y/new_beta_release_develop_v0101248/)
+- Radarr Postgres Database Support in `nightly` and `develop`
+- Prowlarr Postgres Database Support in `nightly` and `develop`
+- [Lidarr Postgres Database Support in development (Draft PR#2625)](https://github.com/Lidarr/Lidarr/pull/2625)
+- [Lidarr UDP Syslog Support in  in development (Draft PR#2655)](https://github.com/Lidarr/Lidarr/pull/2655)

scripts/lidarr_changelog_post.sh

@@ -0,0 +1,105 @@
+#!/bin/bash
+# Generate a Markdown change log of pull requests from commits between two tags
+scriptDir=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
+ghRepo="Prowlarr"
+#branch="develop"
+#read -r -p "What Repo?: " ghRepo
+#read -r -p "What Org?: [Default:$ghRepo]" ghOrg
+read -r -p "What Branch? [master|develop|nightly]:" branch
+ghOrg=${ghOrg:-$ghRepo}
+ghRepoUrl=https://github.com/$ghOrg/$ghRepo
+
+case "${branch}" in
+master)
+    hotioBranch='release'
+    lsioBranch='latest'
+    branchType='Stable'
+    ;;
+develop)
+    hotioBranch='testing'
+    lsioBranch='develop'
+    branchType='Beta'
+    ;;
+nightly)
+    hotioBranch='nightly'
+    lsioBranch='nightly'
+    branchType='Alpha'
+    ;;
+esac
+baseDir=$(dirname "$scriptDir")
+changelogDir="$baseDir/changelogs/"
+templateDir="$changelogDir/templates/"
+# Get a list of all tags in reverse order
+# Assumes the tags are in version format like v1.2.3
+gitTags=$(git ls-remote -t --exit-code --refs --sort='-v:refname' "$ghRepoUrl" | sed -E 's/^[[:xdigit:]]+[[:space:]]+refs\/tags\/(.+)/\1/g')
+
+# Make the tags an array
+
+# shellcheck disable=SC2206
+tags=($gitTags)
+
+latestTag=${tags[0]}
+previousTag=${tags[1]}
+
+# Get a log of commits that occurred between two tags
+# See Pretty format placeholders at https://git-scm.com/docs/pretty-formats
+# -i -E --grep="(Fixed:|New:)"'
+commits=$(git log --pretty=format:' - %s%n' "$previousTag".."$latestTag")
+# Store our changelog in a variable to be saved to a file at the end
+markdown="# New ${branchType^} Release"
+markdown+='\n\n'
+markdown+="$ghRepo $latestTag has been released on \`$branch\`"
+markdown+='\n\n'
+branchmsg=$(cat "$templateDir"/branch-$branch.md)
+if [ -n "$branchmsg" ]; then
+    {
+        markdown+=$branchmsg
+        markdown+='\n\n'
+    }
+fi
+markdown+="# Announcements"
+markdown+='\n\n'
+markdown+=$(cat "$templateDir"/announcements.md)
+markdown+='\n\n'
+markdown+="# Additional Commentary"
+markdown+='\n\n'
+markdown+=$(cat "$templateDir"/commentary.md)
+markdown+='\n\n'
+markdown+="# Releases"
+markdown+='\n\n'
+markdown+="## Native"
+markdown+="\n\n"
+markdown+="- [GitHub Releases]($ghRepoUrl/releases)"
+markdown+="\n\n"
+markdown+="- [Wiki Installation Instructions](https://wiki.servarr.com/${ghRepo,,}/installation)"
+markdown+="\n\n"
+markdown+="## Docker"
+markdown+="\n\n"
+markdown+="- [hotio/$ghRepo:$hotioBranch](https://hotio.dev/containers/${ghRepo,,})"
+markdown+="\n\n"
+markdown+="- [lscr.io/linuxserver/$ghRepo:$lsioBranch](https://docs.linuxserver.io/images/docker-${ghRepo,,})"
+markdown+="\n\n"
+markdown+="## NAS Packages"
+markdown+="\n\n"
+markdown+="- Synology - Please ask the SynoCommunity to update the base package; however, you can update in-app normally"
+markdown+="\n\n"
+markdown+="- QNAP - Please ask the QNAP to update the base package; however, you should be able to update in-app normally"
+markdown+="\n\n"
+markdown+="------------"
+markdown+="\n\n"
+markdown+="# Release Notes"
+markdown+="\n\n"
+markdown+="## $latestTag (changes since $previousTag)"
+markdown+="\n\n"
+markdown+="$commits"
+markdown+="\n\n"
+markdown+=" - Other bug fixes and improvements, see GitHub history"
+# Loop over each commit and look for merged pull requests
+#for COMMIT in $COMMITS; do
+
+#done
+
+# Save our markdown to a file
+mkdir -p "$changelogDir"
+echo -e "$markdown" >"$changelogDir/CHANGELOG-$latestTag.md"
+exit 0