Docs and output tinkering for commit check (#1191)

Author: chadwhitacre

README.md

@@ -24,7 +24,7 @@ Please keep in mind to check the `.env` file for changes, when you perform an up
 
 To get started with all the defaults, simply clone the repo and run `./install.sh` in your local check-out. Sentry uses Python 3 by default since December 4th, 2020 and Sentry 21.1.0 is the last version to support Python 2.
 
-During the install, a prompt will ask if you want to create a user account. If you require that the install not be blocked by the prompt, run `./install.sh --no-user-prompt`.
+During the install, a prompt will ask if you want to create a user account. If you require that the install not be blocked by the prompt, run `./install.sh --skip-user-prompt`.
 
 Please visit [our documentation](https://develop.sentry.dev/self-hosted/) for everything else.
 

install/check-latest-commit.sh

@@ -1,11 +1,15 @@
-#!/bin/bash
+echo "${_group}Checking for latest commit ... "
 
 # Checks if we are on latest commit from github if it is running from master branch
 if [[ -d "../.git" && "${SKIP_COMMIT_CHECK:-0}" != 1 ]]; then
   if [[ $(git branch | sed -n '/\* /s///p') == "master" ]]; then
     if [[ $(git rev-parse HEAD) != $(git ls-remote $(git rev-parse --abbrev-ref @{u} | sed 's/\// /g') | cut -f1) ]]; then
-      echo "Seems like you are not using the latest commit from self-hosted repository. Please pull the latest changes and try again.";
+      echo "Seems like you are not using the latest commit from the self-hosted repository. Please pull the latest changes and try again, or suppress this check with --skip-commit-check.";
       exit 1
     fi
   fi
+else
+  echo "skipped"
 fi
+
+echo "${_endgroup}"

install/parse-cli.sh

@@ -4,14 +4,20 @@ show_help() {
   cat <<EOF
 Usage: $0 [options]
 
-Install Sentry with `docker compose`.
+Install Sentry with \`docker compose\`.
 
 Options:
  -h, --help             Show this message and exit.
- --no-user-prompt       Skips the initial user creation prompt (ideal for non-interactive installs).
- --minimize-downtime    EXPERIMENTAL: try to keep accepting events for as long as possible while upgrading.
-                        This will disable cleanup on error, and might leave your installation in partially upgraded state.
-                        This option might not reload all configuration, and is only meant for in-place upgrades.
+ --minimize-downtime    EXPERIMENTAL: try to keep accepting events for as long
+                          as possible while upgrading. This will disable cleanup
+                          on error, and might leave your installation in a
+                          partially upgraded state. This option might not reload
+                          all configuration, and is only meant for in-place
+                          upgrades.
+ --skip-commit-check    Skip the check for the latest commit when on the master
+                          branch of a \`self-hosted\` Git working copy.
+ --skip-user-prompt     Skip the initial user creation prompt (ideal for non-
+                          interactive installs).
 EOF
 }
 
@@ -22,7 +28,8 @@ SKIP_COMMIT_CHECK="${SKIP_COMMIT_CHECK:-}"
 while (( $# )); do
   case "$1" in
     -h | --help) show_help; exit;;
-    --no-user-prompt) SKIP_USER_PROMPT=1;;
+    --no-user-prompt) SKIP_USER_PROMPT=1;;  # deprecated
+    --skip-user-prompt) SKIP_USER_PROMPT=1;;
     --minimize-downtime) MINIMIZE_DOWNTIME=1;;
     --skip-commit-check) SKIP_COMMIT_CHECK=1;;
     --) ;;