Add CurseForge release workflow

scripts/generate_changelog.sh

@@ -15,14 +15,15 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
 
-# A script for generating a changelog from Git.
-#
 # Note that this script is designed for use in GitHub Actions, and is not
 # particularly robust nor configurable. Run from project parent directory.
 
 # Query GitHub for the username of the given email address.
 # Falls through to the given author name.
-lookup_email_username() {
+function lookup_email_username() {
+  # Ensure fallthrough is set
+  ${2:?Must provide email and username as parameters, i.e. 'lookup_email_username admin@example.com Admin'}
+
   lookup=$(curl -G --data-urlencode "q=$1 in:email" https://api.github.com/search/users -H 'Accept: application/vnd.github.v3+json' | grep '"login":' | sed -e 's/^.*": "//g' -e 's/",.*$//g')
 
   if [[ $lookup ]]; then
@@ -32,10 +33,23 @@ lookup_email_username() {
   fi
 }
 
+# Get a pretty list of supported Minecraft versions
+function get_minecraft_versions() {
+  versions=$(. ./scripts/get_spigot_versions.sh)
+
+  for version in "${versions[@]}"; do
+    # Append comma if variable is set, then append version
+    minecraft_versions="${minecraft_versions:+${minecraft_versions},}${version%%-R*}"
+  done
+
+  echo "${minecraft_versions}"
+}
+
 # Use formatted log to pull authors list
 authors_raw=$(git log --pretty=format:"%ae|%an" "$(git describe --tags --abbrev=0 @^)"..@)
 readarray -t authors <<<"$authors_raw"
 
+# Use associative array to map email to author name
 declare -A author_data
 
 for author in "${authors[@]}"; do
@@ -55,7 +69,7 @@ for author in "${authors[@]}"; do
 done
 
 # Fetch actual formatted changelog
-changelog=$(git log --pretty=format:"%s (%h) - %ae" "$(git describe --tags --abbrev=0 @^)"..@)
+changelog=$(git log --pretty=format:"* %s (%h) - %ae" "$(git describe --tags --abbrev=0 @^)"..@)
 
 for author_email in "${!author_data[@]}"; do
   # Ignore case when matching
@@ -64,4 +78,6 @@ for author_email in "${!author_data[@]}"; do
   changelog=${changelog//$author_email/${author_data[$author_email]}}
 done
 
-echo "GENERATED_CHANGELOG<<EOF${changelog}EOF" >> "$GITHUB_ENV"
+minecraft_versions=$(get_minecraft_versions)
+
+printf "## Supported Minecraft versions\n%s\n\n##Changelog\n%s" "${minecraft_versions}" "${changelog}"

scripts/get_spigot_versions.sh

@@ -0,0 +1,56 @@
+#!/bin/bash
+#
+# Copyright (C) 2011-2021 lishid. All rights reserved.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, version 3.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+
+# Note that this script is designed for use in GitHub Actions, and is not
+# particularly robust nor configurable. Run from project parent directory.
+
+# Use a nameref as a cache - maven evaluation is pretty slow.
+# Re-calling the script and relying on it to handle caching is way easier than passing around info.
+declare -a spigot_versions
+
+# We don't care about concatenation - either it's not null and we return or it's null and we instantiate.
+# shellcheck disable=SC2199
+if [[ ${spigot_versions[@]} ]]; then
+  for spigot_version in "${spigot_versions[@]}"; do
+    echo "$spigot_version"
+  done
+  return
+fi
+
+# Pull Spigot dependency information from Maven.
+modules=$(mvn help:evaluate -Dexpression=project.modules -q -DforceStdout -P all -pl internal | grep -oP '(?<=<string>)(.*)(?=<\/string>)')
+
+declare -n versions="spigot_versions"
+
+for module in "${modules[@]}"; do
+  # Get number of dependencies declared in pom of specified internal module.
+  max_index=$(mvn help:evaluate -Dexpression=project.dependencies -q -DforceStdout -P all -pl internal/"$module" | grep -c "<dependency>")
+
+  for ((i=0; i < max_index; i++)); do
+    # Get artifactId of dependency.
+    artifact_id=$(mvn help:evaluate -Dexpression=project.dependencies["$i"].artifactId -q -DforceStdout -P all -pl internal/"$module")
+
+    # Ensure dependency is Spigot.
+    if [[ "$artifact_id" == spigot ]]; then
+      # Get Spigot version.
+      spigot_version=$(mvn help:evaluate -Dexpression=project.dependencies["$i"].version -q -DforceStdout -P all -pl internal/"$module")
+      versions+=("$spigot_version")
+      echo "$spigot_version"
+      break
+    fi
+  done
+done

scripts/install_spigot_dependencies.sh

@@ -15,39 +15,12 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
 
-# A script for installing required Spigot versions.
-#
-# Note that this script is designed for use in GitHub Actions, and is
-# not particularly robust nor configurable.
-# In its current state, the script must be run from OpenInv's parent
-# project directory and will always install BuildTools to ~/buildtools.
+# Note that this script is designed for use in GitHub Actions, and is not
+# particularly robust nor configurable. Run from project parent directory.
 
 buildtools_dir=~/buildtools
 buildtools=$buildtools_dir/BuildTools.jar
 
-get_spigot_versions () {
-  # Get all submodules of internal module
-  modules=$(mvn help:evaluate -Dexpression=project.modules -q -DforceStdout -P all -pl internal | grep -oP '(?<=<string>)(.*)(?=<\/string>)')
-  for module in "${modules[@]}"; do
-
-    # Get number of dependencies declared in pom of specified internal module
-    max_index=$(mvn help:evaluate -Dexpression=project.dependencies -q -DforceStdout -P all -pl internal/"$module" | grep -c "<dependency>")
-
-    for ((i=0; i < max_index; i++)); do
-      # Get artifactId of dependency
-      artifact_id=$(mvn help:evaluate -Dexpression=project.dependencies["$i"].artifactId -q -DforceStdout -P all -pl internal/"$module")
-
-      # Ensure dependency is spigot
-      if [[ "$artifact_id" == spigot ]]; then
-        # Get spigot version
-        spigot_version=$(mvn help:evaluate -Dexpression=project.dependencies["$i"].version -q -DforceStdout -P all -pl internal/"$module")
-        echo "$spigot_version"
-        break
-      fi
-    done
-  done
-}
-
 get_buildtools () {
   if [[ -d $buildtools_dir && -f $buildtools ]]; then
     return
@@ -57,7 +30,7 @@ get_buildtools () {
   wget https://hub.spigotmc.org/jenkins/job/BuildTools/lastSuccessfulBuild/artifact/target/BuildTools.jar -O $buildtools
 }
 
-versions=$(get_spigot_versions)
+versions=$(. ./scripts/get_spigot_versions.sh)
 echo Found Spigot dependencies: "$versions"
 
 for version in "${versions[@]}"; do
@@ -66,7 +39,7 @@ for version in "${versions[@]}"; do
   mvn dependency:get -Dartifact=org.spigotmc:spigot:"$version" -q -o || exit_code=$?
   if [ $exit_code -ne 0 ]; then
     echo Installing missing Spigot version "$version"
-    revision=$(echo "$version" | grep -oP '(\d+\.\d+(\.\d+)?)(?=-R[0-9\.]+-SNAPSHOT)')
+    revision=${version//-R.*/}
     get_buildtools
     java -jar $buildtools -rev "$revision"
   else

scripts/set_curseforge_env.sh

@@ -0,0 +1,42 @@
+#!/bin/bash
+#
+# Copyright (C) 2011-2021 lishid. All rights reserved.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, version 3.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+
+# Note that this script is designed for use in GitHub Actions, and is not
+# particularly robust nor configurable. Run from project parent directory.
+
+# Parse Spigot dependency information into major Minecraft versions
+function get_curseforge_minecraft_versions() {
+  versions=$(. ./scripts/get_spigot_versions.sh)
+
+  for version in "${versions[@]}"; do
+    # Parse Minecraft major version
+    version="${version%[.-]"${version#*.*[.-]}"}"
+
+    # Skip already listed versions
+    if [[ "$minecraft_versions" =~ "$version"($|,) ]]; then
+      continue
+    fi
+
+    # Append comma if variable is set, then append version
+    minecraft_versions="${minecraft_versions:+${minecraft_versions},}Minecraft ${version}"
+  done
+
+  echo "${minecraft_versions}"
+}
+
+minecraft_versions=$(get_curseforge_minecraft_versions)
+echo "CURSEFORGE_MINECRAFT_VERSIONS=$minecraft_versions"

scripts/set_release_env.sh

@@ -0,0 +1,32 @@
+#!/bin/bash
+#
+# Copyright (C) 2011-2021 lishid. All rights reserved.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, version 3.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+
+# Note that this script is designed for use in GitHub Actions, and is not
+# particularly robust nor configurable. Run from project parent directory.
+
+# Get a pretty string of the project's name and version
+# Disable SC warning about variable expansion for this function - those are Maven variables.
+# shellcheck disable=SC2016
+function get_versioned_name() {
+  mvn -q -Dexec.executable=echo -Dexec.args='${project.name} ${project.version}' --non-recursive exec:exec
+}
+
+# Set GitHub environmental variables
+echo "VERSIONED_NAME=$(get_versioned_name)" >> "$GITHUB_ENV"
+
+changelog="$(. ./scripts/generate_changelog.sh)"
+printf "GENERATED_CHANGELOG<<EOF\n%s\nEOF\n" "$changelog" >> "$GITHUB_ENV"