Add help

Author: jabou

app-deploy.sh

@@ -1,10 +1,11 @@
 #!/usr/bin/env bash
 
+source /usr/local/bin/.app-deploy-sources/__constants.sh
+source /usr/local/bin/.app-deploy-sources/__help.sh
 if [ -z "$1" ] || [ "$1" == 'trigger' ] ; then
     source ./.deploy-options.sh
     source /usr/local/bin/.app-deploy-sources/__trigger_deploy.sh
 fi
-source /usr/local/bin/.app-deploy-sources/__constants.sh
 source /usr/local/bin/.app-deploy-sources/__auto_update.sh
 source /usr/local/bin/.app-deploy-sources/__init.sh
 source /usr/local/bin/.app-deploy-sources/__env_extractor.sh
@@ -28,7 +29,9 @@ set -e
 #       START EVERYTHING        #
 #################################
 
-if [ "$1" == '--update' ] ; then
+if [ "$1" == '--help' ] ; then
+    __help
+elif [ "$1" == '--update' ] ; then
     __clear_console
     __script_auto_update
 elif [ "$1" == 'init' ] ; then

sources/__help.sh

@@ -0,0 +1,49 @@
+################
+#     HELP     #
+################
+
+function __help { 
+        cat << EOF
+Usage: app-deploy [OPTION] [ARGUMENTS]
+
+A group of scripts and tools designed to assist in the deployment process. This script can:
+  - Initialize deploy options.
+  - Create trigger tag for CI/CD.
+  - Extract environments from a trigger tag.
+  - Generate a final build tag after CI/CD deployment.
+
+Parameters:
+  --update                  Update the script to the latest version.
+  init                      Initialize the deploy-options file for the project.
+  trigger                   Generate a trigger tag for starting the CI/CD flow.
+  environments <trigger-tag>
+                            Extract environments from the specified trigger tag.
+  tagging                   Generate a build tag after CI/CD uploads the build.
+                            Accepts the following options:
+    -e <environment>        Specify the environment to use as a tag prefix (e.g., internal-staging).
+    -p <file-path>          Path to the file from which app version, build number, etc., will be extracted.
+                            Supported formats: ipa, apk, aab. 
+                            Use in combination with -v for unsupported formats (e.g. zip).
+    -b <build-count>        Specify the build count, usually the CI/CD counter.
+    -v <custom-app-version> Optional: Override the app version extracted from the file.
+                            Useful for unsupported formats.
+    -c <changelog>          Optional: Add a changelog to the release tag.
+
+Examples:
+  1. Initialize deploy options:
+      app-deploy init
+
+  2. Generate a trigger tag:
+      app-deploy or app-deploy trigger
+      output: ci/internal-staging/2024-12-12T14-32
+
+  3. Extract environments from a trigger tag:
+      app-deploy environments ci/internal-staging/2024-12-12T14-32
+      output: internal-staging
+
+  4. Generate a final build tag:
+      app-deploy tagging -e "internal-staging" -p "path/to/my-app.ipa" -b "123" -c "Added new features"
+      output: internal-staging/v1.2.3-44b123
+
+EOF
+}