Improve variable naming with MODRINTH_MODPACK_VERSION_TYPE and MODRINTH_PROJECTS_DEFAULT_VERSION_TYPE (#3716)

docs/mods-and-plugins/modrinth.md

@@ -92,7 +92,7 @@ When the environment variable `VERSION_FROM_MODRINTH_PROJECTS` is set to "true"
 `MODRINTH_DOWNLOAD_DEPENDENCIES`
 : Can be set to `none` (the default), `required`, or `optional` to download required and/or optional dependencies.
 
-`MODRINTH_ALLOWED_VERSION_TYPE`
+`MODRINTH_PROJECTS_DEFAULT_VERSION_TYPE`
 : The version type is used to determine the newest version to use from each project. The allowed values are `release` (default), `beta`, `alpha`. Setting to `beta` will pick up both release and beta versions. Setting to `alpha` will pick up release, beta, and alpha versions.
 
 `MODRINTH_LOADER`

docs/types-and-platforms/mod-platforms/modrinth-modpacks.md

@@ -24,7 +24,7 @@ The desired modpack project is specified with the `MODRINTH_MODPACK` environment
 
 The automatic modpack version resolving can be narrowed in a few ways:
 
-The latest release or beta version, respectively, of the Modrinth modpack is selected when `VERSION` is "LATEST" or "SNAPSHOT". That can be overridden by setting `MODRINTH_DEFAULT_VERSION_TYPE` to "release", "beta", or "alpha".
+The latest release or beta version, respectively, of the Modrinth modpack is selected when `VERSION` is "LATEST" or "SNAPSHOT". That can be overridden by setting `MODRINTH_MODPACK_VERSION_TYPE` to "release", "beta", or "alpha".
 
 The resolved modpack version can be narrowed by setting `VERSION` to a specific Minecraft version, such as "1.19.2".
 

examples/modrinth/modrinth-modpack/compose.yml

@@ -8,14 +8,14 @@ services:
     environment:
       EULA: "TRUE"
       MODPACK_PLATFORM: MODRINTH
-      MODRINTH_MODPACK: https://modrinth.com/modpack/cobblemon-fabric/version/1.3.2
+      MODRINTH_MODPACK: https://modrinth.com/modpack/cobblemon-fabric/version/1.6.1.4
       # or for auto-upgrading to latest
       # MODRINTH_MODPACK: https://modrinth.com/modpack/cobblemon-fabric
       # or just cobblemon-fabric or 5FFgwNNP
       # and could replace version URL with
-      # MODRINTH_VERSION: nvrqJg44
+      # MODRINTH_VERSION: 98odLiu9
-      # MODRINTH_VERSION: 1.3.2
+      # MODRINTH_VERSION: 1.6.1.4
-      # MODRINTH_VERSION: "Cobblemon [Fabric] 1.3.2"
+      # MODRINTH_VERSION: "Cobblemon [Fabric] 1.6.1.4"
     volumes:
       # attach the relative directory 'data' to the container's /data path
       - ./data:/data

examples/modrinth/modrinth-paper/compose.yml

@@ -6,6 +6,6 @@ services:
       TYPE: PAPER
       VERSION: 1.19.3
       MODRINTH_PROJECTS: "coreprotect"
-      MODRINTH_ALLOWED_VERSION_TYPE: "release"
+      MODRINTH_PROJECTS_DEFAULT_VERSION_TYPE: "release"
     volumes:
       - ./data:/data

scripts/start-deployModrinth

@@ -40,13 +40,14 @@ fi
 
 case "${VERSION^^}" in
   LATEST)
-    : "${MODRINTH_DEFAULT_VERSION_TYPE:=release}"
+    # need to be backward compatible with old variable name, MODRINTH_DEFAULT_VERSION_TYPE
+    : "${MODRINTH_MODPACK_VERSION_TYPE:=${MODRINTH_DEFAULT_VERSION_TYPE:-release}}"
     ;;
   SNAPSHOT)
-    : "${MODRINTH_DEFAULT_VERSION_TYPE:=beta}"
+    : "${MODRINTH_MODPACK_VERSION_TYPE:=${MODRINTH_DEFAULT_VERSION_TYPE:-beta}}"
     ;;
   *)
-    : "${MODRINTH_DEFAULT_VERSION_TYPE:=release}"
+    : "${MODRINTH_MODPACK_VERSION_TYPE:=${MODRINTH_DEFAULT_VERSION_TYPE:-release}}"
     args+=("--game-version=$VERSION")
     ;;
 esac
@@ -61,7 +62,7 @@ setArg() {
 }
 setArg --loader MODRINTH_LOADER
 setArg --version MODRINTH_VERSION
-setArg --default-version-type MODRINTH_DEFAULT_VERSION_TYPE
+setArg --default-version-type MODRINTH_MODPACK_VERSION_TYPE
 setArg --exclude-files MODRINTH_EXCLUDE_FILES
 setArg --force-include-files MODRINTH_FORCE_INCLUDE_FILES
 setArg --overrides-exclusions MODRINTH_OVERRIDES_EXCLUSIONS

scripts/start-setupModpack

@@ -253,7 +253,8 @@ function handleGenericPacks() {
 }
 
 function handleModrinthProjects() {
-  : "${MODRINTH_ALLOWED_VERSION_TYPE:=release}"
+  # need to be backward compatible with old variable name, MODRINTH_ALLOWED_VERSION_TYPE
+  : "${MODRINTH_PROJECTS_DEFAULT_VERSION_TYPE:=${MODRINTH_ALLOWED_VERSION_TYPE:-release}}"
   : "${MODRINTH_DOWNLOAD_DEPENDENCIES:=none}"
   if [[ -v MODRINTH_DOWNLOAD_OPTIONAL_DEPENDENCIES ]]; then
     logWarning "The variable MODRINTH_DOWNLOAD_OPTIONAL_DEPENDENCIES is removed."
@@ -283,7 +284,7 @@ function handleModrinthProjects() {
       --game-version="${VERSION}" \
       --loader="$loader" \
       --download-dependencies="$MODRINTH_DOWNLOAD_DEPENDENCIES" \
-      --allowed-version-type="$MODRINTH_ALLOWED_VERSION_TYPE"
+      --allowed-version-type="$MODRINTH_PROJECTS_DEFAULT_VERSION_TYPE"
   fi
 }