[ci] fix some shellcheck warnings in package-building scripts (#6641)

* Shellcheck compliance improvement (commit squashing)

* rolledback some sh files to address PR review

* Addressing comments on PR review

* Update docs/build-docs.sh

* checking gh login

* fixing cmakelint

* another fix to failing ci

* fixing linting ignoring files

* Fixing shellcheck issues on build-python and build-cran-package scripts

* Update build-cran-package.sh
Co-authored-by: James Lamb <jaylamb20@gmail.com>

* Update build-cran-package.sh
Co-authored-by: James Lamb <jaylamb20@gmail.com>

* Update build-cran-package.sh
Co-authored-by: James Lamb <jaylamb20@gmail.com>

* Adressing PR comments

* fixing CI

* Update build-python.sh
Co-authored-by: James Lamb <jaylamb20@gmail.com>

* Update build-python.sh
Co-authored-by: James Lamb <jaylamb20@gmail.com>

* Update build-python.sh
Co-authored-by: James Lamb <jaylamb20@gmail.com>

* Update build-python.sh
Co-authored-by: James Lamb <jaylamb20@gmail.com>

* Update build-python.sh
Co-authored-by: James Lamb <jaylamb20@gmail.com>

* fixing quotemark typo

* fix CI

* fix CI

* triggering new CI (scikit-learn dev has changed)

* adressing PR comments

* ignore warnings about BUILD_ARGS and PIP_INSTALL_ARGS

---------
Co-authored-by: vnherdeiro <vnherdeiro@github.com>
Co-authored-by: James Lamb <jaylamb20@gmail.com>

build-cran-package.sh

@@ -27,7 +27,7 @@
 #     # skip vignette building
 #     sh build-cran-package.sh --no-build-vignettes
 
-set -e -E -u
+set -e -u
 
 # Default values of arguments
 BUILD_VIGNETTES=true
@@ -63,7 +63,7 @@ CURRENT_DATE=$(date +'%Y-%m-%d')
 
 # R packages cannot have versions like 3.0.0rc1, but
 # 3.0.0-1 is acceptable
-LGB_VERSION=$(cat VERSION.txt | sed "s/rc/-/g")
+LGB_VERSION=$(head -1 ./VERSION.txt | sed "s/rc/-/g")
 
 # move relevant files
 cp -R R-package/* "${TEMP_R_DIR}"
@@ -91,10 +91,10 @@ mkdir -p "${EIGEN_R_DIR}"
 
 modules="Cholesky Core Dense Eigenvalues Geometry Householder Jacobi LU QR SVD"
 for eigen_module in ${modules}; do
-    cp external_libs/eigen/Eigen/${eigen_module} "${EIGEN_R_DIR}/${eigen_module}"
-    if [ ${eigen_module} != "Dense" ]; then
+    cp "external_libs/eigen/Eigen/${eigen_module}" "${EIGEN_R_DIR}/${eigen_module}"
+    if [ "${eigen_module}" != "Dense" ]; then
         mkdir -p "${EIGEN_R_DIR}/src/${eigen_module}/"
-        cp -R external_libs/eigen/Eigen/src/${eigen_module}/* "${EIGEN_R_DIR}/src/${eigen_module}/"
+        cp -R "external_libs/eigen/Eigen/src/${eigen_module}"/* "${EIGEN_R_DIR}/src/${eigen_module}/"
     fi
 done
 
@@ -130,6 +130,7 @@ cd "${TEMP_R_DIR}"
     # Rtools35 (used with R 3.6 on Windows) doesn't support C++17
     LGB_CXX_STD="C++17"
     using_windows_and_r3=$(
+        # shellcheck disable=SC2016
         Rscript -e 'cat(.Platform$OS.type == "windows" && R.version[["major"]] < 4)'
     )
     if test "${using_windows_and_r3}" = "TRUE"; then
@@ -142,7 +143,7 @@ cd "${TEMP_R_DIR}"
     # not allow you to use compiler flag '-Wno-unknown-pragmas' or
     # pragmas that suppress warnings.
     echo "Removing unknown pragmas in headers"
-    for file in $(find . -name '*.h' -o -name '*.hpp' -o -name '*.cpp'); do
+    find . \( -name '*.h' -o -name '*.hpp' -o -name '*.cpp' \) -exec \
       sed \
         -i.bak \
         -e 's/^.*#pragma clang diagnostic.*$//' \
@@ -151,9 +152,7 @@ cd "${TEMP_R_DIR}"
         -e 's/^.*#pragma region.*$//' \
         -e 's/^.*#pragma endregion.*$//' \
         -e 's/^.*#pragma warning.*$//' \
-        "${file}"
-    done
-    find . -name '*.h.bak' -o -name '*.hpp.bak' -o -name '*.cpp.bak' -exec rm {} \;
+        {} +
 
     # 'processx' is listed as a 'Suggests' dependency in DESCRIPTION
     # because it is used in install.libs.R, a file that is not
@@ -164,7 +163,7 @@ cd "${TEMP_R_DIR}"
         DESCRIPTION
 
     echo "Cleaning sed backup files"
-    rm *.bak
+    find . -name '*.bak' -exec rm {} \;
 
 cd "${ORIG_WD}"
 

build-python.sh

@@ -60,7 +60,7 @@
 #                                   Install into user-specific instead of global site-packages directory.
 #                                   Only used with 'install' command.
 
-set -e -E -u
+set -e -u
 
 echo "building lightgbm"
 
@@ -91,42 +91,42 @@ while [ $# -gt 0 ]; do
     # customized library paths #
     ############################
     --boost-dir|--boost-dir=*)
-        if [[ "$1" != *=* ]];
+        if echo "$1" | grep -q '^*=*$';
             then shift;
         fi
         BOOST_DIR="${1#*=}"
         BUILD_ARGS="${BUILD_ARGS} --config-setting=cmake.define.Boost_DIR='${BOOST_DIR}'"
         ;;
     --boost-include-dir|--boost-include-dir=*)
-        if [[ "$1" != *=* ]];
+        if echo "$1" | grep -q '^*=*$';
             then shift;
         fi
         BOOST_INCLUDE_DIR="${1#*=}"
         BUILD_ARGS="${BUILD_ARGS} --config-setting=cmake.define.Boost_INCLUDE_DIR='${BOOST_INCLUDE_DIR}'"
         ;;
     --boost-librarydir|--boost-librarydir=*)
-        if [[ "$1" != *=* ]];
+        if echo "$1" | grep -q '^*=*$';
             then shift;
         fi
         BOOST_LIBRARY_DIR="${1#*=}"
         BUILD_ARGS="${BUILD_ARGS} --config-setting=cmake.define.BOOST_LIBRARYDIR='${BOOST_LIBRARY_DIR}'"
         ;;
     --boost-root|--boost-root=*)
-        if [[ "$1" != *=* ]];
+        if echo "$1" | grep -q '^*=*$';
             then shift;
         fi
         BOOST_ROOT="${1#*=}"
         BUILD_ARGS="${BUILD_ARGS} --config-setting=cmake.define.Boost_ROOT='${BOOST_ROOT}'"
         ;;
     --opencl-include-dir|--opencl-include-dir=*)
-        if [[ "$1" != *=* ]];
+        if echo "$1" | grep -q '^*=*$';
             then shift;
         fi
         OPENCL_INCLUDE_DIR="${1#*=}"
         BUILD_ARGS="${BUILD_ARGS} --config-setting=cmake.define.OpenCL_INCLUDE_DIR='${OPENCL_INCLUDE_DIR}'"
         ;;
     --opencl-library|--opencl-library=*)
-        if [[ "$1" != *=* ]];
+        if echo "$1" | grep -q '^*=*$';
             then shift;
         fi
         OPENCL_LIBRARY="${1#*=}"
@@ -254,14 +254,14 @@ create_isolated_source_dir() {
     modules="Cholesky Core Dense Eigenvalues Geometry Householder Jacobi LU QR SVD"
     for eigen_module in ${modules}; do
         cp \
-            external_libs/eigen/Eigen/${eigen_module} \
-            ./lightgbm-python/external_libs/eigen/Eigen/${eigen_module}
-        if [ ${eigen_module} != "Dense" ]; then
-            mkdir -p ./lightgbm-python/external_libs/eigen/Eigen/src/${eigen_module}/
+            "external_libs/eigen/Eigen/${eigen_module}" \
+            "./lightgbm-python/external_libs/eigen/Eigen/${eigen_module}"
+        if [ "${eigen_module}" != "Dense" ]; then
+            mkdir -p "./lightgbm-python/external_libs/eigen/Eigen/src/${eigen_module}/"
             cp \
                 -R \
-                external_libs/eigen/Eigen/src/${eigen_module}/* \
-                ./lightgbm-python/external_libs/eigen/Eigen/src/${eigen_module}/
+                "external_libs/eigen/Eigen/src/${eigen_module}"/* \
+                "./lightgbm-python/external_libs/eigen/Eigen/src/${eigen_module}/"
         fi
     done
 
@@ -308,6 +308,7 @@ if test "${INSTALL}" = true; then
         # use regular-old setuptools for these builds, to avoid
         # trying to recompile the shared library
         sed -i.bak -e '/start:build-system/,/end:build-system/d' pyproject.toml
+        # shellcheck disable=SC2129
         echo '[build-system]' >> ./pyproject.toml
         echo 'requires = ["setuptools"]' >> ./pyproject.toml
         echo 'build-backend = "setuptools.build_meta"' >> ./pyproject.toml
@@ -339,6 +340,7 @@ fi
 if test "${BUILD_SDIST}" = true; then
     echo "--- building sdist ---"
     rm -f ../dist/*.tar.gz
+    # shellcheck disable=SC2086
     python -m build \
         --sdist \
         --outdir ../dist \
@@ -349,6 +351,7 @@ fi
 if test "${BUILD_WHEEL}" = true; then
     echo "--- building wheel ---"
     rm -f ../dist/*.whl || true
+    # shellcheck disable=SC2086
     python -m build \
         --wheel \
         --outdir ../dist \
@@ -360,18 +363,19 @@ if test "${INSTALL}" = true; then
     echo "--- installing lightgbm ---"
     cd ../dist
     if test "${BUILD_WHEEL}" = true; then
-        PACKAGE_NAME="lightgbm*.whl"
+        PACKAGE_NAME="$(echo lightgbm*.whl)"
     else
-        PACKAGE_NAME="lightgbm*.tar.gz"
+        PACKAGE_NAME="$(echo lightgbm*.tar.gz)"
     fi
     # ref for use of '--find-links': https://stackoverflow.com/a/52481267/3986677
+    # shellcheck disable=SC2086
     pip install \
         ${PIP_INSTALL_ARGS} \
         --force-reinstall \
         --no-cache-dir \
         --no-deps \
         --find-links=. \
-        ${PACKAGE_NAME}
+        "${PACKAGE_NAME}"
     cd ../
 fi