MON-294 add comments

scripts/01_update_output.sh

@@ -4,11 +4,15 @@ set -xueo pipefail
 source "$(dirname $0)/utils.sh"
 goto_root
 
+# loop over every monitors set
 for path in $(find "$(get_scope $1)" -path ./incubator -prune -o -name 'monitors-*.tf' -print | sort -fdbi); do
     cd $(dirname $path)
+    # empty outputs
     > outputs.tf
+    # loop over monitors for each set
     for monitor in $(grep 'resource "datadog_monitor"' $(basename $path) | awk '{print $3}' | tr -d '"' ); do
         echo $monitor
+        # create output block for current monitor
         cat >> outputs.tf <<EOF
 output "${monitor}_id" {
   description = "id for monitor $monitor"

scripts/02_update_readme.sh

@@ -4,22 +4,34 @@ set -xueo pipefail
 source "$(dirname $0)/utils.sh"
 goto_root
 
+## root README generator
+# only keep current README from begining to "Monitors summary" section (delete monitors list)
 sed -i '/### Monitors summary ###/q' README.md
+# add a newline after listing section
 echo >> README.md
+# loop over all ready monitors sets on the repo
 for path in $(find -mindepth 1 \( -path './incubator' -o -path './scripts' -o -path './testing'  -o -path '*/\.*' \) -prune -o -type d -print | sort -fdbi); do
+    # split path in directories
     directories=($(list_dirs $path))
+    # loop over directories in path
     for i in $(seq 1 $((${#directories[@]}-1))); do
+        ## add tabulation for every subdirectory
         echo -en "\t" >> README.md
     done
+    # add link to list of monitors sets
     echo -en "- [$(basename ${path})](https://bitbucket.org/morea/terraform.feature.datadog/src/master/" >> README.md
+    # add path to link
     for directory in "${directories[@]}"; do
         echo -en "${directory}/" >> README.md
     done
+    # end of markdown link
     echo ")" >> README.md
 done
 
+# this is the pattern from where custom information is saved to be restored
 PATTERN_DOC="Related documentation"
 
+# loop over every monitors set readme
 for path in $(find "$(get_scope $1)" -path ./incubator -prune -o -name 'monitors-*.tf' -print | sort -fdbi); do
     cd $(dirname $path)
     EXIST=0
@@ -27,11 +39,16 @@ for path in $(find "$(get_scope $1)" -path ./incubator -prune -o -name 'monitors
         mv README.md README.md.bak
         EXIST=1
     fi
+    # module name from path
     module=$(list_dirs $(dirname ${path}))
+    # module name with space as separator
     module_space=${module^^}
+    # module name with dash as separator
     module_dash=${module//[ ]/-}
+    # module name with slash as separator
     module_slash=${module//[ ]/\/}
 
+    # (re)generate README from scratch
     cat <<EOF > README.md
 # ${module_space} DataDog monitors
 
@@ -45,10 +62,13 @@ module "datadog-monitors-${module_dash}" {
   message     = "\${module.datadog-message-alerting.alerting-message}"
 EOF
 
+    # if README already exist
     if [[ $EXIST -eq 1 ]]; then
+        # take all custom config in declaration module example after "message" and until the end of block to restore it
         sed -n '/^[[:space:]]*message[[:space:]]*=.*/,/^\}/p' README.md.bak | tail -n +2 | head -n -1 >> README.md
     fi
 
+    # close block and generate the next until list of monitors
     cat <<EOF >> README.md
 }
 
@@ -60,22 +80,31 @@ Creates DataDog monitors with the following checks:
 
 EOF
     SAVEIFS=$IFS
+    # allow looping over strings which contains spaces
     IFS=$(echo -en "\n\b")
+    # loop over each monitor in the set
     for match in $(grep -E ^[[:space:]]+name[[:space:]]+= $(basename ${path}) | sort -fdbi); do
+        # parse monitor's name
         name=$(get_name "${match}")
+        # monitor name element to the list and replace "could reach" pattern to "forecast" for better naming
         echo "- ${name/could reach/forecast}" >> README.md
     done
     IFS=$SAVEIFS
+    # auto generate terraform docs (inputs and outputs)
     terraform-docs md ./ >> README.md
+    # if README does not exist
     if [[ $EXIST -eq 0 ]]; then
+        # Simply add empty documentation section
         cat <<EOF >> README.md
 ## ${PATTERN_DOC}
 
 EOF
     else
+        # else restore the custom information saved before
         grep -Pzo --color=never ".*${PATTERN_DOC}(.*\n)*" README.md.bak | head -n -1 >> README.md
         rm README.md.bak
     fi
+    # force unix format (I don't know why for now but you never know)
     dos2unix README.md
     cd - >> /dev/null
 done

scripts/03_update_module.sh

@@ -4,10 +4,14 @@ set -xueo pipefail
 source "$(dirname $0)/utils.sh"
 goto_root
 
+# loop over every monitors set
 for path in $(find "$(get_scope $1)" -path ./incubator -prune -o -name 'monitors-*.tf' -print | sort -fdbi); do
     cd $(dirname $path)
+    # get name of the monitors set directory
     resource="$(basename $(dirname $path))"
+    # if modules.tf does not exist AND if this set respect our tagging convention
     if ! [ -f modules.tf ] && grep -q filter_tags_use_defaults inputs.tf; then
+        # add the filter tags module
         cat > modules.tf <<EOF
 module "filter-tags" {
   source = "../../common/filter-tags"