2022.08.14:

* fixed: bash/github: utils.sh, set-env-from-args.sh: missed to ignore `GITHUB_*` builtin variables, execution fixup
* new: bash/github: init-basic-workflow.sh, enable-github-env-autoeval.sh: Ability to apply GitHub Actions job environment variables by the `GITHUB_ENV` file path automatically on each GitHub Actions job step line instead of on the next step only. A workflow does require to enable this explicitly using the `enable-github-env-autoeval.sh` script run.
* changed: bash/github: utils.sh, set-env-from-args.sh: added global bash variables assign additionally to `GITHUB_ENV` file update to apply variables assign immediately for the same GitHub Actions job step line
* refactor: bash/github: `GH_*` global environment variables renamed into `GHWF_*`, added prefix to the rest

Author: andry81

bash/github/enable-github-env-autoeval.sh

@@ -0,0 +1,108 @@
+#!/bin/bash
+
+# NOTE:
+#   This is a composite script to use from a composite GitHub action.
+#
+
+# Script both for execution and inclusion.
+[[ -z "$BASH" || (-n "$SOURCE_GHWF_ENABLE_GITHUB_ENV_AUTOEVAL_SH" && SOURCE_GHWF_ENABLE_GITHUB_ENV_AUTOEVAL_SH -ne 0) ]] && return
+
+SOURCE_GHWF_ENABLE_GITHUB_ENV_AUTOEVAL_SH=1 # including guard
+
+[[ -z "$GH_WORKFLOW_ROOT" ]] && {
+  echo "$0: error: \`GH_WORKFLOW_ROOT\` variable must be defined." >&2
+  exit 255
+}
+
+source "$GH_WORKFLOW_ROOT/_externals/tacklelib/bash/tacklelib/bash_tacklelib" || exit $?
+
+tkl_include_or_abort "$GH_WORKFLOW_ROOT/bash/github/utils.sh"
+
+
+function gh_enable_github_auto_eval()
+{
+  [[ -z "$GITHUB_ACTIONS" ]] && return 0
+
+  if [[ -z "${GHWF_GITHUB_ENV_AUTOEVAL:+x}" ]]; then # to save veriable between workflow steps
+    gh_set_env_var GHWF_GITHUB_ENV_AUTOEVAL  1
+  fi
+}
+
+function gh_disable_github_auto_eval()
+{
+  [[ -z "$GITHUB_ACTIONS" ]] && return 0
+
+  gh_unset_env_var GHWF_GITHUB_ENV_AUTOEVAL
+}
+
+# Reads and evaluates `GITHUB_ENV` file to setup environment variables immediately
+# and avoids wait for the next GitHub Actions job step to use them.
+#
+# CAUTION:
+#   The function can has differences with the internal load logic and so can
+#   has incorrect or deviated results.
+#
+function gh_eval_github_env_file()
+{
+  local __vars_file="$1"
+
+  local IFS
+  local __line
+  local __line_filtered
+  local __empty
+  local __prefix
+  local __var
+  local __value
+  local __eof
+  local __read_var=0
+
+  while IFS=$'\r\n' read -r __line; do
+    if [[ -z "$__line" ]]; then
+      continue
+    fi
+
+    gh_trim_trailing_line_return_chars "$__line"
+
+    __line_filtered="$RETURN_VALUE"
+
+    if (( ! __read_var )); then
+      IFS='<' read -r __var __empty __eof <<< "$__line_filtered"
+      if [[ -z "$__eof" ]]; then
+        IFS='=' read -r __var empty <<< "$__line_filtered"
+        IFS='=' read -r empty __value <<< "$__line"
+
+        case "$__var" in
+          # ignore system and builtin variables
+          __* | GITHUB_* | 'IFS') ;;
+          *) tkl_declare_global "$__var" "$__value" ;;
+        esac
+      else
+        case "$__var" in
+          # ignore system and builtin variables
+          __* | GITHUB_* | 'IFS') ;;
+          *)
+            __read_var=1
+            __value=''
+            ;;
+        esac
+      fi
+    elif [[ "$__line_filtered" != "$__eof" ]]; then
+      __value="$__value$__line"$'\n'
+    else
+      tkl_declare_global "$__var" "$__value"
+      __read_var=0
+    fi
+  done < "$__vars_file"
+}
+
+function gh_eval_github_env()
+{
+  [[ -z "$GITHUB_ACTIONS" ]] && return 0
+
+  gh_eval_github_env_file "$GITHUB_ENV"
+}
+
+if [[ -z "$BASH_LINENO" || BASH_LINENO[0] -eq 0 ]]; then
+  # Script was not included, then execute it.
+  gh_enable_github_auto_eval "$@"
+fi

bash/github/init-basic-workflow.sh

@@ -53,14 +53,19 @@ source "$GH_WORKFLOW_ROOT/_externals/tacklelib/bash/tacklelib/bash_tacklelib" ||
 tkl_include_or_abort "$GH_WORKFLOW_ROOT/bash/github/init-print-workflow.sh"
 tkl_include_or_abort "$GH_WORKFLOW_ROOT/bash/github/utils.sh"
 
+# does not enable or disable by default, just does include a functionality
+tkl_include_or_abort "$GH_WORKFLOW_ROOT/bash/github/enable-github-env-autoeval.sh"
+
 
 function init_basic_workflow()
 {
-  if [[ -z "${CHANGELOG_BUF_STR:+x}" ]]; then # to save buffer between workflow steps
-    tkl_declare_global CHANGELOG_BUF_STR ''
+  # load GitHub Actions variables at first
+  if (( GHWF_GITHUB_ENV_AUTOEVAL )); then
+    gh_eval_github_env
+  fi
 
-    # update GitHub pipeline variable
-    gh_set_env_var CHANGELOG_BUF_STR "$CHANGELOG_BUF_STR"
+  if [[ -z "${GHWF_CHANGELOG_BUF_STR:+x}" ]]; then # to save buffer between workflow steps
+    gh_set_env_var GHWF_CHANGELOG_BUF_STR  ''
   fi
 
   [[ -z "$CONTINUE_ON_INVALID_INPUT" ]] && CONTINUE_ON_INVALID_INPUT=0
@@ -83,20 +88,17 @@ init_basic_workflow || exit $?
 function gh_prepend_changelog_file()
 {
   (( ! ENABLE_GENERATE_CHANGELOG_FILE )) && return 0
-  [[ -z "$CHANGELOG_BUF_STR" ]] && return 0
+  [[ -z "$GHWF_CHANGELOG_BUF_STR" ]] && return 0
 
   if [[ -f "$CHANGELOG_FILE" && -s "$CHANGELOG_FILE" ]]; then
-    local changelog_buf="${CHANGELOG_BUF_STR}"$'\r\n'"$(< "$CHANGELOG_FILE")"
+    local changelog_buf="${GHWF_CHANGELOG_BUF_STR}"$'\r\n'"$(< "$CHANGELOG_FILE")"
   else
-    local changelog_buf="${CHANGELOG_BUF_STR}"
+    local changelog_buf="${GHWF_CHANGELOG_BUF_STR}"
   fi
 
   echo -n "$changelog_buf" > "$CHANGELOG_FILE"
 
-  CHANGELOG_BUF_STR=''
-
-  # update GitHub pipeline variable
-  gh_set_env_var CHANGELOG_BUF_STR "$CHANGELOG_BUF_STR"
+  gh_set_env_var GHWF_CHANGELOG_BUF_STR ''
 }
 
 tkl_set_return

bash/github/init-print-workflow.sh

@@ -30,24 +30,16 @@ function init_print_workflow()
 
   if [[ -n "$GITHUB_ACTIONS" ]]; then
     # to save variables between workflow steps
-    if [[ -z "${GH_ANNOTATIONS_PRINT_BUF_STR:+x}" ]]; then
-      tkl_declare_global GH_ANNOTATIONS_PRINT_BUF_STR ''
-
-      # update GitHub pipeline variables
-      gh_set_env_var GH_ANNOTATIONS_PRINT_BUF_STR       "$GH_ANNOTATIONS_PRINT_BUF_STR"
+    if [[ -z "${GHWF_ANNOTATIONS_PRINT_BUF_STR:+x}" ]]; then
+      gh_set_env_var GHWF_ANNOTATIONS_PRINT_BUF_STR ''
     fi
 
     # to save variables between workflow steps
-    if [[ -z "${GH_ANNOTATIONS_GROUP_ANNOT_TYPE:+x}" ]]; then
-      tkl_declare_global GH_ANNOTATIONS_GROUP_ANNOT_TYPE ''
-      tkl_declare_global GH_ANNOTATIONS_GROUP_ANNOT_PREFIX ''
-      tkl_declare_global GH_ANNOTATIONS_GROUP_ANNOT_MSG ''
-      tkl_declare_global GH_ANNOTATIONS_GROUP_ANNOT_INDEX 0
-
-      gh_set_env_var GH_ANNOTATIONS_GROUP_ANNOT_TYPE    "$GH_ANNOTATIONS_GROUP_ANNOT_TYPE"
-      gh_set_env_var GH_ANNOTATIONS_GROUP_ANNOT_PREFIX  "$GH_ANNOTATIONS_GROUP_ANNOT_PREFIX"
-      gh_set_env_var GH_ANNOTATIONS_GROUP_ANNOT_MSG     "$GH_ANNOTATIONS_GROUP_ANNOT_MSG"
-      gh_set_env_var GH_ANNOTATIONS_GROUP_ANNOT_INDEX   "$GH_ANNOTATIONS_GROUP_ANNOT_INDEX"
+    if [[ -z "${GHWF_ANNOTATIONS_GROUP_ANNOT_TYPE:+x}" ]]; then
+      gh_set_env_var GHWF_ANNOTATIONS_GROUP_ANNOT_TYPE    ''
+      gh_set_env_var GHWF_ANNOTATIONS_GROUP_ANNOT_PREFIX  ''
+      gh_set_env_var GHWF_ANNOTATIONS_GROUP_ANNOT_MSG     ''
+      gh_set_env_var GHWF_ANNOTATIONS_GROUP_ANNOT_INDEX   0
     fi
   fi
 
@@ -73,23 +65,23 @@ function gh_flush_print_buffers()
   local line
 
   # notices
-  if [[ -n "${PRINT_NOTICE_BUF_STR+x}" ]]; then
-    line="${PRINT_NOTICE_BUF_STR}"
-    unset PRINT_NOTICE_BUF_STR
+  if [[ -n "${GHWF_PRINT_NOTICE_BUF_STR+x}" ]]; then
+    line="${GHWF_PRINT_NOTICE_BUF_STR}"
+    gh_unset_env_var GHWF_PRINT_NOTICE_BUF_STR
     gh_print_notices_buffer "$line"
   fi
 
   # warnings
-  if [[ -n "${PRINT_WARNING_BUF_STR+x}" ]]; then
-    line="${PRINT_WARNING_BUF_STR}"
-    unset PRINT_WARNING_BUF_STR
+  if [[ -n "${GHWF_PRINT_WARNING_BUF_STR+x}" ]]; then
+    line="${GHWF_PRINT_WARNING_BUF_STR}"
+    gh_unset_env_var GHWF_PRINT_WARNING_BUF_STR
     gh_print_warnings_buffer "$line"
   fi
 
   # errors
-  if [[ -n "${PRINT_ERROR_BUF_STR+x}" ]]; then
-    line="${PRINT_ERROR_BUF_STR}"
-    unset PRINT_ERROR_BUF_STR
+  if [[ -n "${GHWF_PRINT_ERROR_BUF_STR+x}" ]]; then
+    line="${GHWF_PRINT_ERROR_BUF_STR}"
+    gh_unset_env_var GHWF_PRINT_ERROR_BUF_STR
     gh_print_errors_buffer "$line"
   fi
 }
@@ -100,10 +92,7 @@ function gh_write_to_changelog_text_ln()
 
   local changelog_msg="$1"
 
-  CHANGELOG_BUF_STR="${CHANGELOG_BUF_STR}${changelog_msg}"$'\r\n'
-
-  # update GitHub pipeline variable
-  gh_set_env_var CHANGELOG_BUF_STR "$CHANGELOG_BUF_STR"
+  gh_set_env_var GHWF_CHANGELOG_BUF_STR "${GHWF_CHANGELOG_BUF_STR}${changelog_msg}"$'\r\n'
 }
 
 function gh_print_args()
@@ -129,17 +118,15 @@ function gh_print_annotation()
   local msg="$3"
 
   #gh_decode_line_return_chars "$msg"
+  RETURN_VALUE="${RETURN_VALUE//%0D%0A/$'\r\n'\| }"
 
   # stdout redirection must be issued outside
   echo "::$annot_type $annot_prefix::$msg"
 
   gh_process_annotation_print "$annot_type" "$annot_prefix" "$msg"
 
-  # duplicate output into `GH_ANNOTATIONS_PRINT_BUF_STR` variable to reuse later
-  GH_ANNOTATIONS_PRINT_BUF_STR="${GH_ANNOTATIONS_PRINT_BUF_STR}${GH_ANNOTATIONS_PRINT_BUF_STR:+"${RETURN_VALUES[0]}"}${RETURN_VALUES[1]}"
-
-  # update GitHub pipeline variable
-  gh_set_env_var GH_ANNOTATIONS_PRINT_BUF_STR "$GH_ANNOTATIONS_PRINT_BUF_STR"
+  # duplicate output into `GHWF_ANNOTATIONS_PRINT_BUF_STR` variable to reuse later
+  gh_set_env_var GHWF_ANNOTATIONS_PRINT_BUF_STR "${GHWF_ANNOTATIONS_PRINT_BUF_STR}${GHWF_ANNOTATIONS_PRINT_BUF_STR:+"${RETURN_VALUES[0]}"}${RETURN_VALUES[1]}"
 }
 
 function gh_flush_print_annotations()
@@ -151,10 +138,11 @@ function gh_flush_print_annotations()
 
   [[ -z "$GITHUB_ACTIONS" ]] && return 0
 
-  IFS=$'\n'; for line in "$GH_ANNOTATIONS_PRINT_BUF_STR"; do
+  IFS=$'\n'; for line in "$GHWF_ANNOTATIONS_PRINT_BUF_STR"; do
     gh_trim_trailing_line_return_chars "$line"
 
-    #gh_decode_line_return_chars "$RETURN_VALUE"
+    # gh_decode_line_return_chars "$RETURN_VALUE"
+    RETURN_VALUE="${RETURN_VALUE//%0D%0A/$'\r\n'\| }"
 
     IFS=':' read -r empty empty annot_type <<< "$RETURN_VALUE"
     IFS=$'\t ' read -r annot_type empty <<< "$annot_type"
@@ -165,10 +153,7 @@ function gh_flush_print_annotations()
     esac
   done
 
-  unset GH_ANNOTATIONS_PRINT_BUF_STR
-
-  # update GitHub pipeline variable
-  gh_set_env_var GH_ANNOTATIONS_PRINT_BUF_STR "$GH_ANNOTATIONS_PRINT_BUF_STR"
+  gh_unset_env_var GHWF_ANNOTATIONS_PRINT_BUF_STR
 }
 
 # NOTE: Groups only annotations with the same type.
@@ -200,40 +185,28 @@ function gh_flush_print_annotations()
 function gh_begin_print_annotation_group()
 {
   [[ -z "$GITHUB_ACTIONS" ]] && return 0
-  [[ -n "${GH_ANNOTATIONS_GROUP_ANNOT_TYPE:+x}" ]] && return 0 # ignore if previous group is not closed/ended
+  [[ -n "${GHWF_ANNOTATIONS_GROUP_ANNOT_TYPE:+x}" ]] && return 0 # ignore if previous group is not closed/ended
 
   local annot_type="$1"         # required
   local annot_prefix="$2"
   local msg="$3"
 
   [[ -z "$annot_type" ]] && return 0
 
-  tkl_declare_global GH_ANNOTATIONS_GROUP_ANNOT_TYPE    "$annot_type"
-  tkl_declare_global GH_ANNOTATIONS_GROUP_ANNOT_PREFIX  "$annot_prefix"
-  tkl_declare_global GH_ANNOTATIONS_GROUP_ANNOT_MSG     "$msg"
-  tkl_declare_global GH_ANNOTATIONS_GROUP_ANNOT_INDEX   0
-
-  # update GitHub pipeline variable
-  gh_set_env_var GH_ANNOTATIONS_GROUP_ANNOT_TYPE    "$GH_ANNOTATIONS_GROUP_ANNOT_TYPE"
-  gh_set_env_var GH_ANNOTATIONS_GROUP_ANNOT_PREFIX  "$GH_ANNOTATIONS_GROUP_ANNOT_PREFIX"
-  gh_set_env_var GH_ANNOTATIONS_GROUP_ANNOT_MSG     "$GH_ANNOTATIONS_GROUP_ANNOT_MSG"
-  gh_set_env_var GH_ANNOTATIONS_GROUP_ANNOT_INDEX   "$GH_ANNOTATIONS_GROUP_ANNOT_INDEX"
+  gh_set_env_var GHWF_ANNOTATIONS_GROUP_ANNOT_TYPE    "$annot_type"
+  gh_set_env_var GHWF_ANNOTATIONS_GROUP_ANNOT_PREFIX  "$annot_prefix"
+  gh_set_env_var GHWF_ANNOTATIONS_GROUP_ANNOT_MSG     "$msg"
+  gh_set_env_var GHWF_ANNOTATIONS_GROUP_ANNOT_INDEX   0
 }
 
 function gh_end_print_annotation_group()
 {
   [[ -z "$GITHUB_ACTIONS" ]] && return 0
 
-  unset GH_ANNOTATIONS_GROUP_ANNOT_TYPE
-  unset GH_ANNOTATIONS_GROUP_ANNOT_PREFIX
-  unset GH_ANNOTATIONS_GROUP_ANNOT_MSG
-  unset GH_ANNOTATIONS_GROUP_ANNOT_INDEX
-
-  # update GitHub pipeline variable
-  gh_set_env_var GH_ANNOTATIONS_GROUP_ANNOT_TYPE    "$GH_ANNOTATIONS_GROUP_ANNOT_TYPE"
-  gh_set_env_var GH_ANNOTATIONS_GROUP_ANNOT_PREFIX  "$GH_ANNOTATIONS_GROUP_ANNOT_PREFIX"
-  gh_set_env_var GH_ANNOTATIONS_GROUP_ANNOT_MSG     "$GH_ANNOTATIONS_GROUP_ANNOT_MSG"
-  gh_set_env_var GH_ANNOTATIONS_GROUP_ANNOT_INDEX   "$GH_ANNOTATIONS_GROUP_ANNOT_INDEX"
+  gh_unset_env_var GHWF_ANNOTATIONS_GROUP_ANNOT_TYPE
+  gh_unset_env_var GHWF_ANNOTATIONS_GROUP_ANNOT_PREFIX
+  gh_unset_env_var GHWF_ANNOTATIONS_GROUP_ANNOT_MSG
+  gh_unset_env_var GHWF_ANNOTATIONS_GROUP_ANNOT_INDEX
 }
 
 # prefixes a print message with annotation data
@@ -243,27 +216,23 @@ function gh_process_annotation_print()
   local annot_prefix="$2"
   local msg="$3"
 
-  if [[ -n "$GH_ANNOTATIONS_GROUP_ANNOT_TYPE" && "$GH_ANNOTATIONS_GROUP_ANNOT_TYPE" == "$annot_type" ]]; then
-    if (( GH_ANNOTATIONS_GROUP_ANNOT_INDEX )); then
-      tkl_declare_global_array RETURN_VALUES "%0A" "$msg"
+  if [[ -n "$GHWF_ANNOTATIONS_GROUP_ANNOT_TYPE" && "$GHWF_ANNOTATIONS_GROUP_ANNOT_TYPE" == "$annot_type" ]]; then
+    if (( GHWF_ANNOTATIONS_GROUP_ANNOT_INDEX )); then
+      tkl_declare_global_array RETURN_VALUES "%0D%0A" "$msg"
     else
-      tkl_declare_global_array RETURN_VALUES $'\r\n' "::$GH_ANNOTATIONS_GROUP_ANNOT_TYPE $GH_ANNOTATIONS_GROUP_ANNOT_PREFIX::${GH_ANNOTATIONS_GROUP_ANNOT_MSG}${GH_ANNOTATIONS_GROUP_ANNOT_MSG:+"%0A"}$msg"
+      tkl_declare_global_array RETURN_VALUES $'\r\n' "::$GHWF_ANNOTATIONS_GROUP_ANNOT_TYPE $GHWF_ANNOTATIONS_GROUP_ANNOT_PREFIX::${GHWF_ANNOTATIONS_GROUP_ANNOT_MSG}${GHWF_ANNOTATIONS_GROUP_ANNOT_MSG:+"%0D%0A"}$msg"
     fi
 
-    (( GH_ANNOTATIONS_GROUP_ANNOT_INDEX++ ))
+    (( GHWF_ANNOTATIONS_GROUP_ANNOT_INDEX++ ))
+
+    gh_update_github_env_var GHWF_ANNOTATIONS_GROUP_ANNOT_INDEX
   else
-    if [[ -n "$GH_ANNOTATIONS_GROUP_ANNOT_TYPE" ]]; then
-      # reset index only to group next prints
-      GH_ANNOTATIONS_GROUP_ANNOT_INDEX=0
+    if [[ -n "$GHWF_ANNOTATIONS_GROUP_ANNOT_TYPE" ]]; then
+      gh_set_env_var GHWF_ANNOTATIONS_GROUP_ANNOT_INDEX 0
     fi
 
     tkl_declare_global_array RETURN_VALUES $'\r\n' "::$annot_type $annot_prefix::$msg"
   fi
-
-  if [[ -n "$GH_ANNOTATIONS_GROUP_ANNOT_TYPE" ]]; then
-    # update GitHub pipeline variable
-    gh_set_env_var GH_ANNOTATIONS_GROUP_ANNOT_INDEX   "$GH_ANNOTATIONS_GROUP_ANNOT_INDEX"
-  fi
 }
 
 tkl_set_return

bash/github/init-yq-workflow.sh

@@ -34,14 +34,17 @@
 # Usage example:
 #
 # >
-# yq_edit '<prefix-name>' 'edit' "<input-yaml>" "$TEMP_DIR/<output-yaml-edited>" \
+# yq_edit "<prefix-name>" "<suffix-name>" "<input-yaml>" "$TEMP_DIR/<output-yaml-edited>" \
 #   <list-of-yq-eval-strings> && \
 #   yq_diff "$TEMP_DIR/<output-yaml-edited>" "<input-yaml>" "$TEMP_DIR/<output-diff-edited>" && \
 #   yq_restore_edited_uniform_diff "$TEMP_DIR/<output-diff-edited>" "$TEMP_DIR/<output-diff-edited-restored>" && \
 #   yq_patch "$TEMP_DIR/<output-yaml-edited>" "$TEMP_DIR/<output-diff-edited-restored>" "$TEMP_DIR/<output-yaml-edited-restored>" "<output-yaml>" ["<input-yaml>"]
 #
 # , where:
 #
+#   <prefix-name> - prefix name part for files in the temporary directory
+#   <suffix-name> - suffix name part for files in the temporary directory
+#
 #   <input-yaml>  - input yaml file path
 #   <output-yaml> - output yaml file path
 #