make script fail safe, interactive, and get started

Author: ccdd12

README.md

@@ -23,18 +23,23 @@ To execute just run the following commaind inside a demo repository:
 # Get started
 
 ```bash
-cwd=$(pwd) && \
-dir=$(mktemp -d -p $cwd test-git-repo-XXXXXXXXX) && \
-mkdir -p $dir && cd $dir && git init && \
-curl -sL 'https://raw.githubusercontent.com/bobbyiliev/github-activity-bash-script/main/activity.sh' | \
-bash -x && \
-git branch -m master main ; \
-echo -e "\n\nTODO push your changes:\n\t\
-  git remote add origin https://github.com/username/reponame\n\t\
-  git push origin --force --set-upstream origin main\n\n" \
-\
+ACTIVITY_BR=main && MAX_PAST_DAYS=365 && COMMIT_NB= && COMMIT_MAX=7 && \
+curl -sL 'https://raw.githubusercontent.com/bobbyiliev/github-activity-bash-script/main/activity.sh' \
+    | bash ;
 ```
 
+# Environment variables
+
+|       env           |   description         | type          |   default value                | 
+|:-------------------:|:---------------------:|:-------------:|:------------------------------:|
+|   `ACTIVITY_BR`     |   working git branch  |  `string`     |      `main`                    |
+|   `MAX_PAST_DAYS`   |   number of past days |  `integer`    |      `365`                     |
+|   `COMMIT_NB`       |   exactly git commit number each past day.                      | `integer`  |             |
+|   `COMMIT_MAX`      |   randomly git commit number each past day between [1..max]     | `integer`  |   `7`       |
+
+* `COMMIT_MAX` used only if `COMMIT_NB` is empty
+* if both `COMMIT_MAX` and `COMMIT_NB`, randomly commit number each past day between [1..7]
+
 # Introduction to Bash Scripting
 
 In case that you are interested in learning more about Bash Scripting, make sure to checkout this open-source eBook:

activity.sh

@@ -1,51 +1,128 @@
 #!/bin/bash
 
-####
+set -e
+
+#
 ## Use for demo purposes only!
 ## To execute just run the following commaind inside a demo repository:
 #
 # wget https://raw.githubusercontent.com/bobbyiliev/github-activity-bash-script/main/activity.sh
 # bash activity.sh
-# # Finllly push your changes to GitHub:
+#
+## Finllly push your changes to GitHub:
+#
 # git push origin -f your_branch_name"
-####
+#
+
+if [[ ! -d ".git" ]] ; then
+  cwd=$(pwd)
+  dir=$(mktemp -d -p $cwd test-git-repo-XXXXXXXXX)
+  mkdir -p $dir
+  cd $dir
+  git init
+  >&2 echo NO. NOT git repo...
+  exit 1
+fi
+
+# thomas-nyman CC BY-SA 3.0 https://unix.stackexchange.com/a/155077
+if [[ -z "$(git status --porcelain)" ]] ; then
+  echo OK. Working directory clean...
+else
+  >&2 echo NO. Working directory NOT clean. Uncommitted changes...
+  exit 2
+fi
+
+if [[ -z "ACTIVITY_BR" ]] ; then
+  ACTIVITY_BR="main"
+fi
+git checkout --orphan $ACTIVITY_BR >/dev/null 2>&1 || git checkout $ACTIVITY_BR > /dev/null 2>&1
 
-##
 # Create temp commits direcotry
-##
 if [[ ! -d .commits ]] ; then
-    mkdir -p .commits
+  mkdir -p .commits
 fi
-##
+
 # Add changes file log
-##
 if [[ ! -f  .commits/changes ]] ; then
-    touch .commits/changes
-    git add .
+  touch .commits/changes
+fi
+
+if [[ -z "$MAX_PAST_DAYS" ]] ; then
+  MAX_PAST_DAYS=365
 fi
 
-##
 # Create commits for the past 365 days
-##
-for day in {1..365} ; do
+for (( day=$MAX_PAST_DAYS; day>=1; day-- )) ; do
     # Get the past date of the commit
     day2=$(date --date="-${day} day" "+%a, %d %b %Y %X %z")
 
     echo "Creating commits for ${day}"
 
     # Generate random number of commits for that date
-    commits=$(( ( RANDOM % 6 )  + 2 ))
+    if [[ -z "$COMMIT_NB" ]] ; then
+      if [[ -z "$COMMIT_MAX" ]] ; then
+        commits=$(( ( RANDOM % 6 ) + 2 ))
+      else
+        commits=$(( ( RANDOM % $COMMIT_MAX ) + 1 ))
+      fi
+    else
+      commits=$COMMIT_NB
+    fi
 
     # Create the comits
     echo "Creating ${commits} commits"
     for ((i=1;i<=${commits};i++)); do
         content=$(date -d "${day2}" +"%s")
         echo ${content}-${i} >> .commits/changes
-        git commit -am "Commit number ${content}-${i}"
+        git add .commits/changes
+        git commit -m "Commit number ${content}-${i}"
         git commit --amend --no-edit --date "${day2}"
     done
 done
 
-echo "Generating commits completed..."
-echo "To push your commits run:"
-echo "git push origin -f your_branch_name"
+function yes_or_no {
+# author   : tiago-lopo john-kugelman CC BY-SA 3.0 https://stackoverflow.com/a/29436423
+# usage    : yes_or_no "$message" && do_something
+# modified
+    while true; do
+        read -p "$* [y/n]: " yn
+        case $yn in
+            [YyOo]*) return 0  ;;
+            [Nn]*) echo "Aborted" ; return  1 ;;
+        esac
+    done
+}
+
+if command -v gh ; then
+  echo
+  echo OK. github cli found.
+  yes_or_no "Did you want to create repo on github ? " && \
+            gh repo create $(basename $(pwd)) \
+              -y \
+              --private \
+              --description 'generated by https://github.com/ccdd12/github-activity-bash-script' \
+              --homepage    'https://github.com/ccdd12/github-activity-bash-script' \
+            >/dev/null 2>&1 || \
+            echo NO. repo already exist.
+fi
+
+echo
+yes_or_no "Did you want to push to remote 'origin' ? " && \
+          git push --force --set-upstream origin $ACTIVITY_BR || \
+          echo OK. push to your own remote remote/branch.
+
+cat << EOF
+
+
+
+      Generating commits completed...
+
+      To push your changes later :
+
+          git remote add                    origin https://github.com/username/$(basename $(pwd))
+
+          gh  repo   create
+          git push   --force --set-upstream origin $ACTIVITY_BR
+
+
+EOF