Docs (ci): Improve documentation on build.sh usage (#148)

startersclan · Jul 25, 2023 · 569a80f · 569a80f
1 parent 124d416
commit 569a80f
Showing 1 changed file with 7 additions and 7 deletions.
diff --git a/build.sh b/build.sh
@@ -25,22 +25,22 @@ usage() {
     echo "                          Type: string"
     echo "  MOD                     Mod. Needed when APPID=90, except for APPID=90 GAME=valve"
     echo "                          Type: string, optional"
-    echo "  FIX_APPMANIFEST         Whether to fix appmanifests."
+    echo "  FIX_APPMANIFEST         Whether to apply appmanifest fixes on builds. Applies only to PIPELINE=build and APPID=90"
     echo "                          Type: bool, optional"
     echo "                          Possible values: 'true', 'false'"
-    echo "  LATEST                  Whether to tag docker image as :latest. Applies only to PIPELINE=build"
+    echo "  LATEST                  Whether to tag the successfully built game image with the :latest tag. Applies only to PIPELINE=build"
     echo "                          Type: bool, optional"
     echo "                          Possible values: 'true', 'false'"
-    echo "  CACHE                   Whether to pull the :latest image before running build"
+    echo "  CACHE                   Whether to pull the game image by the :latest tag before build"
     echo "                          Type: bool, optional"
     echo "                          Possible values: 'true', 'false'"
-    echo "  NO_PULL                 Whether to skip pulling :latest image before building. Applies only to PIPELINE=update"
+    echo "  NO_PULL                 Whether to skip pulling the game image by the :latest image before build. Applies only to PIPELINE=update"
     echo "                          Type: bool, optional"
     echo "                          Possible values: 'true', 'false'"
-    echo "  NO_TEST                 Whether to skip testing the game image after a successful build"
+    echo "  NO_TEST                 Whether to skip testing of the successfully built game image"
     echo "                          Type: bool, optional"
     echo "                          Possible values: 'true', 'false'"
-    echo "  NO_PUSH                 Whether to skip pushing the docker image after a successful build"
+    echo "  NO_PUSH                 Whether to skip pushing of the successfully built game image"
     echo "                          Type: bool, optional"
     echo "                          Possible values: 'true', 'false'"
     echo "  DOCKER_REPOSITORY       Docker repository"
@@ -49,7 +49,7 @@ usage() {
     echo "                          Type: string"
     echo "  REGISTRY_PASSWORD       Docker registry password"
     echo "                          Type: string"
-    echo "  STEAM_LOGIN             Whether to logon to Steam so that games download without rate limiting. Generally needed when APPID=90"
+    echo "  STEAM_LOGIN             Whether to logon to Steam so that games download without rate limiting. Generally required for APPID=90"
     echo "                          Type: bool, optional"
     echo "  STEAM_USERNAME          Steam username"
     echo "                          Type: string"