[Breaking Change] (config) Adjust the log message.

Chisanan232 · Chisanan232 · commit 5cf64811c682 · 2022-09-01T09:35:48.000+08:00
diff --git a/scripts/ci/build_git-tag_or_create_github-release.sh b/scripts/ci/build_git-tag_or_create_github-release.sh
@@ -5,24 +5,24 @@
 # Check whether it has 'release-notes.md' or 'release-title.md' in the target directory '.github'.
 has_auto_release_flag=$(ls .github | grep -E "release-auto-flag.txt")
 if [ "$has_auto_release_flag" == "" ]; then
-    echo "It should have *release-auto-flag.txt* in '.github' directory of your project in HitHub."
+    echo "⚠️ It should have *release-auto-flag.txt* in '.github' directory of your project in HitHub."
     exit 0
 else
     auto_release_flag=$(cat .github/release-auto-flag.txt)
     if [ "$auto_release_flag" == false ]; then
-        echo "Auto-release flag is 'false' so it won't build git tag or create GitHub release."
+        echo "💤 Auto-release flag is 'false' so it won't build git tag or create GitHub release."
         exit 0
     fi
 fi
 
 has_release_notes=$(ls .github | grep -E "release-notes.md")
 has_release_title=$(ls .github | grep -E "release-title.md")
 if [ "$has_release_notes" == "" ]; then
-    echo "It should have *release-notes.md* in '.github' directory of your project in HitHub."
+    echo "❌ It should have *release-notes.md* in '.github' directory of your project in HitHub."
     exit 1
 fi
 if [ "$has_release_title" == "" ]; then
-    echo "It should have *release-title.md* in '.github' directory of your project in HitHub."
+    echo "❌ It should have *release-title.md* in '.github' directory of your project in HitHub."
     exit 1
 fi
 
@@ -31,6 +31,11 @@ fi
 Input_Arg_Release_Type=$1
 Input_Arg_Debug_Mode=$2
 
+if [ "$Input_Arg_Release_Type" == "" ]; then
+    echo "❌ The argument 'Input_Arg_Release_Type' (first argument) cannot be empty."
+    exit 1
+fi
+
 if [ "$Input_Arg_Release_Type" == 'python-package' ]; then
     # # # # The name of Python package
     Input_Arg_Python_Pkg_Name=$3
@@ -42,18 +47,13 @@ elif [ "$Input_Arg_Release_Type" == 'github-action-reusable-workflow' ]; then
     Input_Arg_Software_Version_Format=""
 #    Input_Arg_Debug_Mode=$2
 else
-    echo "Currently, it only has 2 release type: 'python-package' or 'github-action-reusable-workflow'."
+    echo "❌ Currently, it only has 2 release type: 'python-package' or 'github-action-reusable-workflow'."
     exit 1
 fi
 if [ "$Input_Arg_Debug_Mode" == "" ]; then
     Input_Arg_Debug_Mode=true
 fi
 
-if [ "$Input_Arg_Release_Type" == "" ]; then
-    echo "The argument 'Input_Arg_Release_Type' (first argument) cannot be empty."
-    exit 1
-fi
-
 
 # # # # From the PEP440: Software version style rule
 # # #
@@ -77,7 +77,7 @@ declare Python_Version_Reg
 if [ "$Input_Arg_Release_Type" == 'python-package' ]; then
 
     if [ "$Input_Arg_Python_Pkg_Name" == "" ]; then
-        echo "The argument 'Input_Arg_Python_Pkg_Name' (second argument) cannot be empty if option 'Input_Arg_Release_Type' (first argument) is 'python-package'."
+        echo "❌ The argument 'Input_Arg_Python_Pkg_Name' (second argument) cannot be empty if option 'Input_Arg_Release_Type' (first argument) is 'python-package'."
         exit 1
     fi
 
@@ -122,7 +122,7 @@ fi
 
 # This is the global value to provide after-handle to use
 Current_Branch=$(git branch --list | cat | grep -E '\* ([a-zA-Z0-9]{1,16})' | grep -E -o '([a-zA-Z0-9]{1,16})')
-echo "Current git branch: $Current_Branch"
+echo "🔎 🌳  Current git branch: $Current_Branch"
 
 
 declare Tag_Version    # This is the return value of function 'get_latest_version_by_git_tag'
@@ -131,14 +131,14 @@ get_latest_version_by_git_tag() {
     get_version_type=$1
 
     if [ "$get_version_type" == "git" ]; then
-        echo ""
+        echo "🔎 🌳 🏷 Get the version info from git tag."
         Tag_Version=$(git describe --tag --abbrev=0 --match "v[0-9]\.[0-9]\.[0-9]*" | grep -E -o '[0-9]\.[0-9]\.[0-9]*')
     elif [ "$get_version_type" == "github" ]; then
-        echo ""
+        echo "🔎 🐙 🐈 🏷  Get the version info from GitHub release."
         github_release=$(curl -s https://api.github.com/repos/Chisanan232/GitHub-Action_Workflow-Template-Python/releases/latest | jq -r '.tag_name')
         Tag_Version=$(echo "$github_release" | grep -E -o '[0-9]\.[0-9]\.[0-9]*')
     else
-        echo ""
+        echo "❌ Currently, it only has 2 valid options could use: 'git' or 'github'."
         exit 1
     fi
 }
@@ -149,14 +149,14 @@ declare New_Release_Tag    # This is the return value of function 'generate_new_
 generate_new_version_as_tag() {
     project_type=$1
     if [ "$project_type" == "python" ]; then
-        echo ""
+        echo "🔎 🐍 📦  Get the new version info from Python package."
         New_Release_Version=$(cat ./"$Input_Arg_Python_Pkg_Name"/__pkg_info__.py | grep -E "$Python_Version_Reg" | grep -E -o "$Software_Version_Reg")
     elif [ "$project_type" == "github-action_reusable-workflow" ]; then
-        echo ""
+        echo "🔎 🐙 🐈 🏷  Get the current version info from GitHub release."
         # Generate the new version from previous tag
         get_latest_version_by_git_tag 'github'
         current_ver=$(echo "$Tag_Version" | head -n1 | cut -d "." -f1)
-        echo "current_ver: $current_ver"
+        echo "🔎 📃  Current Version: $current_ver"
 
 #        current_ver=$(git describe --tag --abbrev=0 --match "v[0-9]\.[0-9]\.[0-9]" | grep -E -o '[0-9]\.[0-9]\.[0-9]' | head -n1 | cut -d "." -f1)
         if [ "$current_ver" == "" ]; then
@@ -178,53 +178,53 @@ build_git_tag_or_github_release() {
     generate_new_version_as_tag "$project_type"
 
     if [ "$Input_Arg_Debug_Mode" == true ]; then
-        echo " 🔍👀[DEBUG MODE] Build git tag $New_Release_Tag in git branch '$Current_Branch'."
+        echo " 🔍👀 [DEBUG MODE] Build git tag $New_Release_Tag in git branch '$Current_Branch'."
     else
         git tag -a "$New_Release_Tag" -m "$New_Release_Tag"
         git push -u origin --tags
     fi
+    echo "🎉 🍻 🌳 🏷  Build git tag which named '$New_Release_Tag' with current branch '$Current_Branch' successfully!"
 
-    echo "Build git tag which named '$New_Release_Tag' with current branch '$Current_Branch' successfully!"
     if [ "$Current_Branch" == "master" ]; then
         release_title=$(cat .github/release-title.md)
 
         if [ "$Input_Arg_Debug_Mode" == true ]; then
-            echo " 🔍👀[DEBUG MODE] Create GitHub release with tag '$New_Release_Tag' and title '$release_title' in git branch '$Current_Branch'."
+            echo " 🔍👀 [DEBUG MODE] Create GitHub release with tag '$New_Release_Tag' and title '$release_title' in git branch '$Current_Branch'."
         else
             gh release create "$New_Release_Tag" --title "$release_title" --notes-file .github/release-notes.md
         fi
-
-        echo "Create GitHub release with title '$release_title' successfully!"
     fi
+        echo "🎉 🍻 🐙 🐈 🏷  Create GitHub release with title '$release_title' successfully!"
 }
 
 
 # The truly running implementation of shell script
 if [ "$Input_Arg_Release_Type" == 'python-package' ]; then
 
     # # # # For Python package release
-    echo 'do python package release'
+    echo "🏃‍♂ ️🐍 𝌚 Run python package releasing process"
 
     git_tag=$(git describe --tag --abbrev=0 --match "v[0-9]\.[0-9]\.[0-9]*" | grep -o '[0-9]\.[0-9]\.[0-9]*')
     github_release=$(curl -s https://api.github.com/repos/Chisanan232/GitHub-Action_Workflow-Template-Python/releases/latest | jq -r '.tag_name')
     # shellcheck disable=SC2002
-    pkg_version=$(cat ./"$Input_Arg_Python_Pkg_Name"/__pkg_info__.py | grep -E "$Python_Version_Reg" | grep -E -o "$Software_Version_Reg")
+    generate_new_version_as_tag "python"
+#    pkg_version=$(cat ./"$Input_Arg_Python_Pkg_Name"/__pkg_info__.py | grep -E "$Python_Version_Reg" | grep -E -o "$Software_Version_Reg")
 
     build_git_tag=false
     create_github_release=false
 
     # 1. Compare the Python source code version and git tag, GitHub release version.
-    if [ "$pkg_version" == "$git_tag" ]; then
-        echo "Version of git tag info are the same. So it verifies it has built and pushed before."
+    if [ "$New_Release_Version" == "$git_tag" ]; then
+        echo "✅  Version of git tag info are the same. So it verifies it has built and pushed before."
     else
-        echo "Version of git tag info are different. So it verifies it doesn't build and push before."
+        echo "⚠️  Version of git tag info are different. So it verifies it doesn't build and push before."
         build_git_tag=true
     fi
 
-    if [ "$Current_Branch" == "master" ] && [ "$pkg_version" == "$github_release" ]; then
-        echo "Version of GitHub release info are the same. So it verifies it has built and pushed before."
+    if [ "$Current_Branch" == "master" ] && [ "$New_Release_Version" == "$github_release" ]; then
+        echo "✅  Version of GitHub release info are the same. So it verifies it has built and pushed before."
     else
-        echo "Version of GitHub release info are different. So it verifies it doesn't build and push before."
+        echo "⚠️  Version of GitHub release info are different. So it verifies it doesn't build and push before."
         create_github_release=true
     fi
 
@@ -239,37 +239,37 @@ if [ "$Input_Arg_Release_Type" == 'python-package' ]; then
 
     if [ "$build_git_tag" == true ] || [ "$create_github_release" == true ]; then
 
-        echo "pkg_version: $pkg_version"
+        echo "🔎 🐍 📦 Python package new release version: $New_Release_Version"
 #        is_pre_release_version=$(echo $pkg_version | sed -n 's/.*\([a-zA-Z][0-9]*\)/\1/p')
-        is_pre_release_version=$(echo $pkg_version | grep -E -o '([\.-]*([a-zA-Z]{1,})+([0-9]{0,})*){1,}')
-        echo "is_pre_release_version: $is_pre_release_version"
+        is_pre_release_version=$(echo $New_Release_Version | grep -E -o '([\.-]*([a-zA-Z]{1,})+([0-9]{0,})*){1,}')
+        echo "🔎 🤰 📦 is pre-release version: $is_pre_release_version"
         if [ "$is_pre_release_version" == "" ]; then
-            echo "The version is not a pre-release."
+            echo "🎓 🐍 📦 The version is a official-release."
             # do different things with different ranches
             # git event: push
             # all branch -> Build tag
             # master branch -> Build tag and create release
-            echo "build tag and create GitHub release, also push code to PyPi"
+            echo "👷🏽‍♂️ 📌 Build tag and create GitHub release, also push code to PyPi"
             build_git_tag_or_github_release "python"
-            echo "Done! This is Official-Release so please push source code to PyPi."
+            echo "✅ 🎊 🥂 Done! This is Official-Release so please push source code to PyPi."
             echo "[Python] [Final Running Result] Official-Release"
         else
             echo "The version is a pre-release."
             # do different things with different ranches
             # git event: push
             # all branch -> Build tag
             # master branch -> Build tag and create release
-            echo "build tag and create GitHub release only"
+            echo "👷🏽‍♂ ️📌 Build tag and create GitHub release only"
             build_git_tag_or_github_release "python"
-            echo "Done! This is Pre-Release so please don't push this to PyPi."
+            echo "✅ 🎊 🥂 Done! This is Pre-Release so please don't push this to PyPi."
             echo "[Python] [Final Running Result] Pre-Release"
         fi
 
     fi
 
 elif [ "$Input_Arg_Release_Type" == 'github-action-reusable-workflow' ]; then
 
-    echo 'do github-action-reusable-workflow release'
+    echo "🏃‍♂  🐙 🐈 𝌚  Run github-action-reusable-workflow releasing process"
     # # # # For GitHub Action reusable workflow template release
     # 1. Compare whether the release-notes.md has different or not.
     # Note 1: Diff a specific file with currently latest tag and previous one commit
@@ -280,28 +280,28 @@ elif [ "$Input_Arg_Release_Type" == 'github-action-reusable-workflow' ]; then
     # Note 4: We should git fetch to provide git diff feature working
     # https://github.com/actions/checkout/issues/160
 
-    echo "Run git fetch to sync upstream with latest project in GitHub"
+    echo "🌳 ⛓ 🌳 Run git fetch to sync upstream with latest project in GitHub"
     git fetch --no-tags --prune --depth=1 origin +refs/heads/*:refs/remotes/origin/*
 
-    echo "Verify all the git branch info again after git fetch."
+    echo "🔎 🌳 🌳 Verify all the git branch info again after git fetch."
     git branch -a | cat
 
-    echo "Verify the git remote info again after git fetch."
+    echo "🔎 🔗 🌳 Verify the git remote info again after git fetch."
     git remote -v
 
-    echo "Check the different between current git branch and master branch."
+    echo "🔬 📄 🌳 ⛓ 🌳 Check the different of '.github/release-notes.md' between current git branch and master branch ..."
     release_notes_has_diff=$(git diff origin/master "$Current_Branch" -- .github/release-notes.md | cat)
-    echo "release_notes_has_diff: $release_notes_has_diff"
+    echo "🔎 🔬 📄 different of '.github/release-notes.md': $release_notes_has_diff"
 
     if [ "$release_notes_has_diff" != "" ]; then
         # 1. Yes, it has different. -> Build git tag, GitHub release and version branch
         build_git_tag_or_github_release "github-action_reusable-workflow"
-        echo "Done! This is Official-Release of GitHub Action reusable workflow, please create a version branch of it."
+        echo "✅ 🎊 🥂 Done! This is Official-Release of GitHub Action reusable workflow, please create a version branch of it."
         echo "[GitHub Action - Reusable workflow] [Final Running Result] Official-Release and version: $New_Release_Version"
     else
         # 1. No, do nothing.
         # Return nothing output
-        echo "Release note file doesn't change. Don't do anything."
+        echo "💤 Release note file doesn't change. Don't do anything."
         echo "[GitHub Action - Reusable workflow] [Final Running Result] Pre-Release"
     fi
 
