Release 25.04

Author: accetto

.gitignore

@@ -3,24 +3,21 @@
 # starting patterns with '/' disables recursivity
 # ending patterns with '/' specifies directories
 # starting patterns with '!' negates them
-# standard glob patterns (shell paterns) work:
+# standard glob patterns (shell patterns) work:
 # '*' matches zero oro more characters
 # '?' matches a single characters
 # '[abc]' matches the characters inside the brackets
 # '[0-9]' matches the characters inside the brackets
 # '**' matches nested directories (e.g. 'a/**/z')
 # recommended files on 'https://github.com/github/gitignore'
 
-..developer*
 .vscode
 .cache*
 .favorites.json
 .g3-cache*
 .secret*
 .util*
 .vscode
-avanti*
-debug*
 scrap*
 secret*
 TODO*

CHANGELOG.md

@@ -6,6 +6,27 @@
 
 ***
 
+### Release 25.04
+
+Availability checking of the `wget` utility has been added.
+The utility is used by the `cache` hook script for downloading of selected packages into the `g3-cache` folders.
+It's generally not available on Windows environments by default.
+You can install it or to build on an environment, where the utility is available (e.g. WSL or Linux).
+
+The checking can be skipped by setting the environment variable `IGNORE_MISSING_WGET=1`.
+
+The selected packages still will be downloaded into a temporary image layer, but not into the project's
+`.g3-cache` folder nor the shared one, defined by the variable `SHARED_G3_CACHE_PATH`.
+
+Other changes:
+
+- The `ci-builder.sh` script's command `log get errors` now lists building errors and also warnings.
+
+Updated components:
+
+- `noVNC` to version **1.6.0**
+- `websockify` to version **0.13.0**
+
 ### Release 25.03 (G3v7)
 
 This is the first `G3v7` release, bringing an improved building pipeline.

builder.sh

@@ -83,15 +83,19 @@ main() {
             clear_log
             "${_build_context}"/hooks/"${cmd}" dev "${blend}" $@
             exit_code=$?
-            if [[ ${exit_code} -ne 0 ]] ; then die "Hook script '${cmd}' failed with code ${exit_code}." ${exit_code} ; fi
+            if [[ ${exit_code} -ne 0 ]] ; then
+                die "Hook script '${cmd}' failed with code ${exit_code}." ${exit_code}
+            fi
             ;;
 
         all | all-no-push )
 
             clear_log
             "${_build_context}"/hooks/pre_build dev "${blend}" $@
             exit_code=$?
-            if [[ ${exit_code} -ne 0 ]] ; then die "Hook script 'pre_build' failed with code ${exit_code}." ${exit_code} ; fi
+            if [[ ${exit_code} -ne 0 ]] ; then
+                die "Hook script 'pre_build' failed with code ${exit_code}." ${exit_code}
+            fi
 
             if [[ ! -f "${_build_context}"/scrap-demand-stop-building ]] ; then
 
@@ -112,7 +116,9 @@ main() {
 
                     "${_build_context}"/hooks/"${c}" dev "${blend}" $@
                     exit_code=$?
-                    if [[ ${exit_code} -ne 0 ]] ; then die "Hook script '${c}' failed with code ${exit_code}." ${exit_code} ; fi
+                    if [[ ${exit_code} -ne 0 ]] ; then
+                        die "Hook script '${c}' failed with code ${exit_code}." ${exit_code}
+                    fi
                 done
 
                 echo

ci-builder.sh

@@ -75,7 +75,7 @@ show_log_timing() {
 
 show_log_errors() {
 
-    echo -e "\n--> Building errors:\n"
+    echo -e "\n--> Building errors and warnings:\n"
     grep -iPn "${_regex_log_errors}" "${_ci_builder_log}"
     echo
 }
@@ -413,7 +413,7 @@ declare _log_mark="\n[CI-BUILDER]"
 declare _regex_log_digest="(?<=\[CI-BUILDER\] ).+"
 declare _regex_log_stickers="Current version sticker of "
 declare _regex_log_timing="==> (EXECUTING @.*builder\.sh.*|FINISHED  @.*builder\.sh.*)"
-declare _regex_log_errors="\berror\b"
+declare _regex_log_errors="\berror\b|\bwarning\b|\bexiting at line\b"
 
 declare _flag_skip_footer=""
 declare _option_nocache=""

cspell.json

@@ -1,12 +1,37 @@
 #!/bin/bash
 
-### @accetto, September 2022
-
 echo -e "\n==> EXECUTING @$(date -u +'%Y-%m-%d_%H-%M-%S'): ${0} $@\n"
 
 declare _mydir=$(dirname $0)
 
 source "${_mydir}"/env.rc
+source "${_mydir}"/util.rc
+
+ensure_wget() {
+    local -i error_code=0
+    local -i enforced_error_code=1
+
+    ### checking can be disabled by passing 'enforced_error_code=0'
+    if [[ "${IGNORE_MISSING_WGET:-0}" == "0" ]] ; then
+        enforced_error_code=1
+    else
+        enforced_error_code=0
+    fi
+    ensure_utility wget ${enforced_error_code}
+
+    error_code=$?
+    if [[ ${error_code} -ne 0 ]] ; then
+        echo
+        echo "WARNING! Utility 'wget' not found."
+        echo "It's recommended to install the utility or to switch to an environment where it's available (e.g. WSL)."
+        echo "Otherwise set the environment variable IGNORE_MISSING_WGET=1 to ignore this checking."
+        echo "The selected packages still will be downloaded into a temporary image layer, but not into the project's"
+        echo "'.g3-cache' folder nor the shared one, defined by the variable SHARED_G3_CACHE_PATH."
+        echo
+
+        die "Utility 'wget' not found." ${error_code}
+    fi
+}
 
 use_wget() {
     local section="${1?Expected section name}"
@@ -169,25 +194,27 @@ cache_chromium() {
 
 main() {
 
+    ensure_wget
+
     if [[ "${FEATURES_VNC}" == "1" ]] ; then
 
         cache_tigervnc
-        if [[ $? -ne 0 ]] ; then return 1; fi
+        if [[ $? -ne 0 ]] ; then return 1 ; fi
     fi
 
     if [[ "${FEATURES_NOVNC}" == "1" ]] ; then
 
         cache_novnc
-        if [[ $? -ne 0 ]] ; then return 1; fi
+        if [[ $? -ne 0 ]] ; then return 1 ; fi
 
         cache_websockify
-        if [[ $? -ne 0 ]] ; then return 1; fi
+        if [[ $? -ne 0 ]] ; then return 1 ; fi
     fi
 
     if [[ "${FEATURES_CHROMIUM}" == "1" ]] ; then
 
         cache_chromium
-        if [[ $? -ne 0 ]] ; then return 1; fi
+        if [[ $? -ne 0 ]] ; then return 1 ; fi
     fi
 
     echo

docker/hooks/cache

@@ -81,7 +81,7 @@ if [[ $# -ge 2 ]] ; then shift 2 ; fi
 ### Remark: There are also 'FEATURES_*' variables that are always set, e.g. 'FEATURES_VERSION_STICKER=1'.
 
 ### These features influence the content of almost all stages:
-### Warning! Anything except '0' means '1', even unset or emty.
+### Warning! Anything except '0' means '1', even unset or empty.
 if [[ "${FEATURES_BUILD_SLIM}" == "0" ]] ; then FEATURES_BUILD_SLIM="" ; else FEATURES_BUILD_SLIM=1 ; fi
 
 ### These features influence the content of the related stages:
@@ -93,7 +93,7 @@ if [[ "${FEATURES_CHROMIUM}" == "1" ]] ; then FEATURES_CHROMIUM=1 ; else FEATURE
 if [[ "${FEATURES_FIREFOX}" == "1" ]] ; then FEATURES_FIREFOX=1 ; else FEATURES_FIREFOX="" ; fi
 
 ### These features influence container behaviour at startup time
-### Warning! Anything except '0' means '1', even unset or emty.
+### Warning! Anything except '0' means '1', even unset or empty.
 if [[ "${FEATURES_OVERRIDING_ENVV}" == "0" ]] ; then FEATURES_OVERRIDING_ENVV="" ; else FEATURES_OVERRIDING_ENVV=1 ; fi
 
 ### These features are always enabled and cannot be disabled via environment variables
@@ -116,8 +116,8 @@ case "${_branch}" in
         ### hardcoded settings
         TIGERVNC_VERSION="1.13.1"
         TIGERVNC_DISTRO="x86_64"
-        NOVNC_VERSION="1.5.0"
-        WEBSOCKIFY_VERSION="0.12.0"
+        NOVNC_VERSION="1.6.0"
+        WEBSOCKIFY_VERSION="0.13.0"
         CHROMIUM_DISTRO="amd64"
 
         ### ---------------------------

docker/hooks/env.rc

@@ -25,9 +25,6 @@ main() {
     local repo_deploy="${_deploy_repo##*/}"
     local keeper_repo_tag="${_deploy_builder_tags[0]}"
 
-    ### debugging support
-    # dump_environment
-
     if [[ ! -f "${_build_context}/${_scrap_demand_stop_building}" ]] ; then
 
         ### essential environment variables must be already set

docker/hooks/post_push

@@ -26,9 +26,6 @@ main() {
         die "Script '${cache_script}' failed with code ${exit_code}." ${exit_code}
     fi
 
-    ### debugging support
-    # dump_environment
-
     echo -e "\nRemoving helper files\n"
     cleanup_scrap_files
 

docker/hooks/pre_build

@@ -1,7 +1,5 @@
 #!/bin/bash
 
-### @accetto, August 2021
-
 echo -e "\n==> EXECUTING @$(date -u +'%Y-%m-%d_%H-%M-%S'): ${0} $@\n"
 
 declare _mydir=$(dirname $0)

docker/hooks/push

@@ -16,34 +16,6 @@ cleanup_scrap_files() {
     rm -f "${_build_context}/${_scrap_prefix}"*
 }
 
-dump_environment() {
-    ### List the selected environment variables.
-    ### Just debugging support.
-
-    echo "Environment dump:"
-    echo "_build_context=${_build_context}"
-    echo "_branch=${_branch}"
-    echo "_blend=${_blend}"
-
-    echo "_owner=${_owner}"
-    echo "DOCKER_REPO=${DOCKER_REPO}"
-    echo "DOCKER_TAG=${DOCKER_TAG}"
-    echo "_deploy_repo=${_deploy_repo}"
-    echo "_deploy_tags=${_deploy_tags[@]}"
-
-    echo "FEATURES_BUILD_SLIM=${FEATURES_BUILD_SLIM}"
-    echo "FEATURES_JQ=${FEATURES_JQ}"
-    echo "FEATURES_NOVNC=${FEATURES_NOVNC}"
-    echo "FEATURES_SCREENSHOOTING=${FEATURES_SCREENSHOOTING}"
-    echo "FEATURES_THUMBNAILING=${FEATURES_THUMBNAILING}"
-
-    echo "DOCKERFILE_PATH=${DOCKERFILE_PATH}"
-    echo "BASEIMAGE=${BASEIMAGE}"
-    echo "BASETAG=${BASETAG}"
-    echo "VERSION_STICKER_PREFIX=${VERSION_STICKER_PREFIX}"
-    echo "VERSION_STICKER_SUFFIX=${VERSION_STICKER_SUFFIX}"
-}
-
 encode_json_quotes() {
     ### Encode double-quotes for use in JSON
     echo "${1//\"/\\\"}"
@@ -54,6 +26,20 @@ encode_json_newlines() {
     echo $( echo -e "${1}" | sed -z 's/\n/\\n/g' )
 }
 
+ensure_utility() {
+    ### Checks availability of the given utility.
+    ### It can be effectively disabled by providing 'enforced_error_code=0'.
+
+    local util_name="${1?Need utility name}"
+    local enforced_error_code=${2?Need enforced error code}
+
+    if command -v "${util_name}" > /dev/null ; then
+        return 0
+    else
+        return ${enforced_error_code}
+    fi
+}
+
 get_label() {
     ### Returning the given label value via the predefined global variable.
 
@@ -125,7 +111,7 @@ list_labels() {
 }
 
 update_gist() {
-    ### Updating the secret GitHub gist containing datat (e.g. badge endpoints).
+    ### Updating the secret GitHub gist containing data (e.g. badge endpoints).
     ### 'GIST_TOKEN' secret (PAT) with the 'gist' scope is required
 
     local gist=${1?Need gist ID}

docker/hooks/util.rc

@@ -175,7 +175,7 @@ main() {
 
         else
 
-            ### tail the null device infinitelly
+            ### tail the null device infinitely
             if [[ -n $"{_verbose}" ]] ; then
 
                 echo "Tailing '/dev/null'"
@@ -186,7 +186,7 @@ main() {
         fi
     fi
 
-    ### default backround execution mode
+    ### default background execution mode
     ### be sure to end all previous branches by calling 'cleanup'
     ### option '--wait' is purely because of the parser
 

docker/src/xfce-startup/startup.sh

@@ -1,5 +1,6 @@
 #!/bin/bash
-### @accetto, September 2019
+
+# cSpell:disable
 
 case "$1" in
     angular | angular-cli | angularcli | ng )

docker/src/xfce-startup/version_of.sh

@@ -1,5 +1,4 @@
 #!/bin/bash
-### @accetto, September 2019
 
 ### resolve also symlinks
 _current_dir="$(dirname "$(readlink -f "$0")")"

docker/src/xfce-startup/version_sticker.sh

@@ -57,6 +57,8 @@ export DOCKER_BUILDKIT=1
 # # export FEATURES_NOVNC=0
 # # export FEATURES_FIREFOX_PLUS=0
 # # export FEATURES_OVERRIDING_ENVV=0
+# ### ignoring 'wget' checking may be helpful on Windows
+# # export IGNORE_MISSING_WGET=1
 
 #endregion
 
@@ -71,7 +73,7 @@ export DOCKER_BUILDKIT=1
 # export REPO_OWNER_NAME=""
 # ### production builder gist
 # export GIST_ID=""
-# ### produktion deployment gist
+# ### production deployment gist
 # export DEPLOY_GIST_ID=""
 # ### note that the reserved repository name 'void' will prohibit the publishing
 # ### primary deployment repos
@@ -91,6 +93,8 @@ export DOCKER_BUILDKIT=1
 # # export FEATURES_NOVNC=0
 # # export FEATURES_FIREFOX_PLUS=0
 # # export FEATURES_OVERRIDING_ENVV=0
+# ### ignoring 'wget' checking may be helpful on Windows
+# # export IGNORE_MISSING_WGET=1
 
 #endregion