From a1b6d702ed837ad2dc84a1bff8cf5ee2b6553d46 Mon Sep 17 00:00:00 2001
From: Alex Fabre <m.alexfabre@gmail.com>
Date: Fri, 15 Nov 2024 11:02:13 +0100
Subject: [PATCH] script: rename script to project-version

This commit also remove mentions to Zephyr project and instead provide
three outputs format:
- h for C header
- hpp for cpp header
- cmake for cmake file (zephyr porject for exemple)
---
 .github/workflows/code-quality.yml            |   2 +-
 .github/workflows/tag-version.yml             |   6 +-
 .gitignore                                    |   5 +-
 README.md                                     |  63 ++++---
 rever.sh => project-version.sh                | 161 +++++++++---------
 ...ersion.sh => check_script_self_version.sh} |  10 +-
 6 files changed, 125 insertions(+), 122 deletions(-)
 rename rever.sh => project-version.sh (61%)
 rename test/{check_rever_version.sh => check_script_self_version.sh} (82%)

diff --git a/.github/workflows/code-quality.yml b/.github/workflows/code-quality.yml
index ba53085..da3e572 100644
--- a/.github/workflows/code-quality.yml
+++ b/.github/workflows/code-quality.yml
@@ -30,5 +30,5 @@ jobs:
       - name: Codespell action
         uses: codespell-project/actions-codespell@v2
         with:
-          ignore_words_list: rever
+          ignore_words_list: project-version
         
diff --git a/.github/workflows/tag-version.yml b/.github/workflows/tag-version.yml
index f15eb2b..cdeb736 100644
--- a/.github/workflows/tag-version.yml
+++ b/.github/workflows/tag-version.yml
@@ -18,8 +18,8 @@ jobs:
         with:
           fetch-depth: 0 # Fetch all history for all branches and tags
 
-      - name: Run rever on itself
-        run: ./rever.sh -l -o base_version.h -f base -t v
+      - name: Run project-version on itself
+        run: ./project-version.sh -l -o version.h -f h -t v
 
       - name: Checking version
-        run: ci-script/check_rever_version.sh rever.sh base_version.h
+        run: ci-script/check_script_self_version.sh project-version.sh version.h
diff --git a/.gitignore b/.gitignore
index 484beb4..79450ec 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,5 +1,4 @@
-# Generated file (base format)
+# Generated file
 version.h
-
-# Generated file (Zephyr format)
+version.hpp
 VERSION
diff --git a/README.md b/README.md
index 5f49648..3bfadd9 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# rever
+# project-version
 
 A little POSIX shell script that generates a C header containing the version information (Major Minor etc...) of a Git based repository.
 
@@ -11,7 +11,7 @@ The script simply parses the `git describe` command to extract the firmware info
 The script will generate a C header file.
 
 ```sh
-./rever.sh -o project/include/version.h
+./project-version.sh -o project/include/version.h
 ```
 
 ### Zephyr project
@@ -19,7 +19,7 @@ The script will generate a C header file.
 The script will generate the cmake version file.
 
 ```sh
-./rever.sh -f zephyr -o cmake-project/VERSION
+./project-version.sh -f zephyr -o cmake-project/VERSION
 ```
 
 ## Requirements
@@ -29,23 +29,24 @@ The script will generate the cmake version file.
 
 ## Usage
 
-Clone the repo or simply copy the `rever.sh` script into your repository and let the magic happen.
+Clone the repo or simply copy the `project-version.sh` script into your repository and let the magic happen.
 
 All available options can be listed with option `-h`
 
 ~~~sh
-$ ./rever.sh -h
-==> rever.sh 0.5.0
+$ ./project-version.sh -h
+==> project-version.sh 0.6.0
 A little POSIX shell script to generate
 version information for your C project.
-ref: https://github.com/AlexFabre/rever
+ref: https://github.com/AlexFabre/project-version
 Usage:
-rever.sh <options>
-    -f <project format>
-        -f zephyr: Generate a 'VERSION' file, specific to zephyr projects
-        -f base: (default) Generate the basic rever format file
-    -o <output file>
-    -t <git tag format> (default 'v')
+project-version.sh <options>
+    -f <output format>
+        -f h : (default) Generate a C header file (.h).
+        -f hpp : Generate a C++ header file (.hpp).
+        -f cmake : Generate a cmake variable file.
+    -o <output file name>
+    -t <git tag format> (default 'v') (ex. 'v' will match tags 'v0.3.1' and 'v0.2.1-beta' but not tags '1.3.4' nor 'version3.2.3')
     -h <help>
     -v <script version>
     -l <script logs> (default none)
@@ -56,15 +57,15 @@ rever.sh <options>
 ~~~c
 /**
  * @file version.h
- * @brief version information of project build
+ * @brief This file declares the firmware revision information
  *
- * Generated with rever.sh 0.5.0
+ * Generated with project-version.sh 0.6.0
  * A little POSIX shell script to generate
  * version information for your C project.
- * ref: https://github.com/AlexFabre/rever
+ * ref: https://github.com/AlexFabre/project-version
  *
  * Do not edit this file manually. Its content
- * is generated with rever.sh script.
+ * is generated with project-version.sh script.
  */
 #ifndef VERSION_H__
 #define VERSION_H__
@@ -75,43 +76,37 @@ rever.sh <options>
 #define VERSION_PATCH                     0
 
 /* Git repo info */
-#define VERSION_BRANCH_NAME               "feat/add-zephyr-compatibility"
-#define VERSION_NB_COMMITS_SINCE_LAST_TAG 6
-#define VERSION_COMMIT_SHORT_SHA          "08df77b"
+#define VERSION_BRANCH_NAME               "main"
+#define VERSION_NB_COMMITS_SINCE_LAST_TAG 3
+#define VERSION_COMMIT_SHORT_SHA          "b620737"
 
 /* Build date time (UTC) */
-#define VERSION_BUILD_DAY                 29
-#define VERSION_BUILD_MONTH               10
+#define VERSION_BUILD_DAY                 15
+#define VERSION_BUILD_MONTH               11
 #define VERSION_BUILD_YEAR                2024
-#define VERSION_BUILD_HOUR                11
+#define VERSION_BUILD_HOUR                9
 
 #endif /* VERSION_H__ */
-
 ~~~
 
 ### Example of generated header for Zephyr project
 
 ~~~txt
-
 # This file declares the firmware revision information
-# both for cmake and for mcuboot
 #
-# ref: https://docs.zephyrproject.org/latest/build/version/index.html
-#
-# Generated with rever.sh 0.5.0
+# Generated with project-version.sh 0.6.0
 # A little POSIX shell script to generate
 # version information for your C project.
-# ref: https://github.com/AlexFabre/rever
+# ref: https://github.com/AlexFabre/project-version
 #
 # Do not edit this file manually. Its content
-# is generated with rever.sh script.
+# is generated with project-version.sh script.
 
 VERSION_MAJOR = 0
 VERSION_MINOR = 5
 PATCHLEVEL = 0
-VERSION_TWEAK = 6
-EXTRAVERSION = "feat/add-zephyr-compatibility08df77b"
-
+VERSION_TWEAK = 3
+EXTRAVERSION = main
 ~~~
 
 ## Code quality
diff --git a/rever.sh b/project-version.sh
similarity index 61%
rename from rever.sh
rename to project-version.sh
index d7fc463..a4dd854 100755
--- a/rever.sh
+++ b/project-version.sh
@@ -1,6 +1,6 @@
 #!/bin/sh
 # ==========================================
-#   rever - A little POSIX shell script to generate
+#   project-version - A little POSIX shell script to generate
 #           version information for your C project
 #   Copyright (C) 2024 Alex Fabre
 #   [Released under MIT License. Please refer to license.txt for details]
@@ -8,40 +8,37 @@
 
 # ==========================================
 # Usage with standard tag names vXX.YY.ZZ
-#   $> rever.sh -o dir/subdir/version.h
+#   $> project-version.sh -o dir/subdir/version.h
 #
 # Usage with custom tag names fw-XX.YY.ZZ
-#   $> rever.sh -o dir/subdir/file_version.h -t fw-
+#   $> project-version.sh -o dir/subdir/file_version.h -t fw-
 # 
 # ==========================================
 
 # Script self version information
-REVER_MAJOR=0
-REVER_MINOR=5
-REVER_PATCH=0
+PROJECT_VERSION_MAJOR=0
+PROJECT_VERSION_MINOR=6
+PROJECT_VERSION_PATCH=0
 
 # Print variables
-REVER_SCRIPT_NAME="rever.sh"
-REVER_VERSION="$REVER_MAJOR.$REVER_MINOR.$REVER_PATCH"
-REVER_INTRO_L1="A little POSIX shell script to generate"
-REVER_INTRO_L2="version information for your C project."
-REVER_INTRO_L3="ref: https://github.com/AlexFabre/rever"
+PROJECT_VERSION_SCRIPT_NAME="project-version.sh"
+PROJECT_VERSION_VERSION="$PROJECT_VERSION_MAJOR.$PROJECT_VERSION_MINOR.$PROJECT_VERSION_PATCH"
+PROJECT_VERSION_INTRO_L1="A little POSIX shell script to generate"
+PROJECT_VERSION_INTRO_L2="version information for your C project."
+PROJECT_VERSION_INTRO_L3="ref: https://github.com/AlexFabre/project-version"
 
 # ==========================================
 # Default settings
 # ==========================================
 
-# If the path provided with option -o does end on a directory 
-# (with a trailing '/' (ex. -o dir/subdir/ )), then the script
-# will create the file in that directory with the following name.
-DEFAULT_FILE_NAME="VERSION"
-
+# Option -t <...>
 # By default the script will look for tags in the format
 # v1.0.4
 # Option -t allow for custom tag prefix
 # ex. "-t fv-" if your tags are like this "fw-1.0.4" 
-TAG_PREFIX="v"
+GIT_TAG_PREFIX="v"
 
+# Option -l
 # By default the script runs and prints only:
 # On success:
 # ==> "./version.h" updated: v0.3.2 (sha: e03685b)
@@ -52,27 +49,37 @@ TAG_PREFIX="v"
 # out during execution
 LOG_VERBOSITY=0
 
+# If the path provided with option -o does end on a directory 
+# (with a trailing '/' (ex. -o dir/subdir/ )), then the script
+# will create the file in that directory with the following name:
+DEFAULT_OUTPUT_FILE_NAME="version"
+
+# Option -o <...>
 # Default file path output
-OUTPUT_FILE_PATH=$DEFAULT_FILE_NAME
+OUTPUT_FILE_PATH=$DEFAULT_OUTPUT_FILE_NAME
 
-OUTPUT_FILE_FORMAT="base"
+# Option -f <...>
+# By default the script will generate a header file (.h) with the
+# various definitions.
+OUTPUT_FORMAT="h"
 
 # ==========================================
 # Script call checks
 # ==========================================
 
 usage() {
-    echo "==> $REVER_SCRIPT_NAME $REVER_VERSION"
-    echo "$REVER_INTRO_L1"
-    echo "$REVER_INTRO_L2"
-    echo "$REVER_INTRO_L3"
+    echo "==> $PROJECT_VERSION_SCRIPT_NAME $PROJECT_VERSION_VERSION"
+    echo "$PROJECT_VERSION_INTRO_L1"
+    echo "$PROJECT_VERSION_INTRO_L2"
+    echo "$PROJECT_VERSION_INTRO_L3"
     echo "Usage:"
-    echo "$REVER_SCRIPT_NAME <options>"
-    echo "    -f <project format>"
-    echo "        -f zephyr: Generate a 'VERSION' file, specific to zephyr projects"
-    echo "        -f base: (default) Generate the basic rever format file"
-    echo "    -o <output file>"
-    echo "    -t <git tag format> (default 'v')"
+    echo "$PROJECT_VERSION_SCRIPT_NAME <options>"
+    echo "    -f <output format>"
+    echo "        -f h : (default) Generate a C header file (.h)."
+    echo "        -f hpp : Generate a C++ header file (.hpp)."
+    echo "        -f cmake : Generate a cmake variable file."
+    echo "    -o <output file name>"
+    echo "    -t <git tag format> (default 'v') (ex. 'v' will match tags 'v0.3.1' and 'v0.2.1-beta' but not tags '1.3.4' nor 'version3.2.3')"
     echo "    -h <help>"
     echo "    -v <script version>"
     echo "    -l <script logs> (default none)"
@@ -82,20 +89,20 @@ usage() {
 while getopts ":f:o:t:hvl" opt; do
     case "${opt}" in
         f)
-            OUTPUT_FILE_FORMAT=${OPTARG}
+            OUTPUT_FORMAT=${OPTARG}
             ;;
         o)
             OUTPUT_FILE_PATH=${OPTARG}
             ;;
         t)
-            TAG_PREFIX=${OPTARG}
+            GIT_TAG_PREFIX=${OPTARG}
             ;;
         h)
             usage
             exit 0
             ;;
         v)
-            echo "$REVER_VERSION"
+            echo "$PROJECT_VERSION_VERSION"
             exit 0
             ;;
         l)
@@ -112,7 +119,8 @@ done
 # Functions
 # ==========================================
 
-# Checks that the path finishes with a valid filename
+# Reads a given 'output file name' and echoes it back, properly formated.
+# If the file is not given, the default name 'version' is used.
 #   ex. valid path with file name
 #       Input "src/subdir/version.h"
 #       Output "src/subdir/version.h"
@@ -129,16 +137,18 @@ file_path_checker() {
 
     # Default filename when missing
     if [ -z "$filename" ]; then
-    filename="$DEFAULT_FILE_NAME""$EXTENSION"
+    filename="$DEFAULT_OUTPUT_FILE_NAME""$OUTPUT_FILE_EXTENSION"
     fi
 
     # Appends the extension if missing
-    filename="${filename%"$EXTENSION"}$EXTENSION"
+    filename="${filename%"$OUTPUT_FILE_EXTENSION"}$OUTPUT_FILE_EXTENSION"
 
     # Return the updated path
     echo "$(dirname "$1")/$filename"
 }
 
+# Print a log message
+# Requires option -l
 log() {
     if [ "$LOG_VERBOSITY" = "1" ]
     then
@@ -157,31 +167,36 @@ then
     exit 1
 fi
 
+# Print git version
 git_version=$(git --version)
 log "$git_version"
 
 # Handle file format depending on project format
-log "Format: $OUTPUT_FILE_FORMAT"
-if [ "$OUTPUT_FILE_FORMAT" = "base" ]; then
-    EXTENSION=".h"
+log "Output format: $OUTPUT_FORMAT"
+if [ "$OUTPUT_FORMAT" = "h" ]; then
+    OUTPUT_FILE_EXTENSION=".h"
 fi
 
-if [ "$OUTPUT_FILE_FORMAT" = "zephyr" ]; then
-    EXTENSION=""
+if [ "$OUTPUT_FORMAT" = "hpp" ]; then
+    OUTPUT_FILE_EXTENSION=".hpp"
+fi
+
+if [ "$OUTPUT_FORMAT" = "cmake" ]; then
+    OUTPUT_FILE_EXTENSION=""
 fi
 
 # Version file path
-FILE_PATH=$(file_path_checker "$OUTPUT_FILE_PATH")
+FORMATED_OUTPUT_FILE_PATH=$(file_path_checker "$OUTPUT_FILE_PATH")
 
-log "output file:" "$FILE_PATH"
+log "output file:" "$FORMATED_OUTPUT_FILE_PATH"
 
-log "tag prefix:" "$TAG_PREFIX"
+log "tag prefix:" "$GIT_TAG_PREFIX"
 
-tag_list=$(git tag -l "$TAG_PREFIX""[0-9]*.[0-9]*.[0-9]*")
+tag_list=$(git tag -l "$GIT_TAG_PREFIX""[0-9]*.[0-9]*.[0-9]*")
 log "tag list:" "$tag_list"
 
 # Git describe command
-GIT_DESCRIBE=$(git describe --tags --long --match "${TAG_PREFIX}[0-9]*.[0-9]*.[0-9]*" 2> /dev/null)
+GIT_DESCRIBE=$(git describe --tags --long --match "${GIT_TAG_PREFIX}[0-9]*.[0-9]*.[0-9]*" 2> /dev/null)
 log "git describe output:" "$GIT_DESCRIBE"
 
 # Check the length of the git describe result
@@ -203,7 +218,7 @@ else
     # Extract the version parts using substring manipulation
 
     # Remove the leading tag prefix
-    GIT_DESCRIBE="${GIT_DESCRIBE#"$TAG_PREFIX"}"
+    GIT_DESCRIBE="${GIT_DESCRIBE#"$GIT_TAG_PREFIX"}"
 
     # Extract the version parts using substring manipulation
     FW_MAJOR="${GIT_DESCRIBE%%.*}"
@@ -237,52 +252,46 @@ MONTH=$(date -u +"%-m")
 HOUR=$(date -u +"%-H")
 
 # Extract filename with extension...
-BASENAME="$(basename "$FILE_PATH")"
+OUTPUT_FILE_NAME="$(basename "$FORMATED_OUTPUT_FILE_PATH")"
 
-# Generated for a Zephyr project
-if [ "$OUTPUT_FILE_FORMAT" = "zephyr" ]; then
+# Generated for a cmake project
+if [ "$OUTPUT_FORMAT" = "cmake" ]; then
     # Modify the tmp version file
     {   echo "# This file declares the firmware revision information";
-        echo "# both for cmake and for mcuboot";
-        echo "#";
-        echo "# ref: https://docs.zephyrproject.org/latest/build/version/index.html";
         echo "#";
-        echo "# Generated with $REVER_SCRIPT_NAME $REVER_VERSION";
-        echo "# $REVER_INTRO_L1";
-        echo "# $REVER_INTRO_L2";
-        echo "# $REVER_INTRO_L3";
+        echo "# Generated with $PROJECT_VERSION_SCRIPT_NAME $PROJECT_VERSION_VERSION";
+        echo "# $PROJECT_VERSION_INTRO_L1";
+        echo "# $PROJECT_VERSION_INTRO_L2";
+        echo "# $PROJECT_VERSION_INTRO_L3";
         echo "#";
         echo "# Do not edit this file manually. Its content";
-        echo "# is generated with rever.sh script.";
+        echo "# is generated with project-version.sh script.";
         echo "";
         echo "VERSION_MAJOR = $FW_MAJOR";
         echo "VERSION_MINOR = $FW_MINOR";
         echo "PATCHLEVEL = $FW_PATCH";
         echo "VERSION_TWEAK = $NB_COMMIT_SINCE_LAST_TAG";
         echo "EXTRAVERSION = $BRANCH_NAME";
-    } > "${FILE_PATH}_tmp"
-fi
-
-# Generated for a base project
-if [ "$OUTPUT_FILE_FORMAT" = "base" ]; then
+    } > "${FORMATED_OUTPUT_FILE_PATH}_tmp"
+else
     # Change filename chars to UPPER and non-alphanum to UNDERSCORES...
-    BUILD_LOCK=$(echo "${BASENAME}" | awk 'BEGIN { getline; print toupper($0) }' | sed 's/[^[:alnum:]\r\t]/_/g')
+    BUILD_LOCK=$(echo "${OUTPUT_FILE_NAME}" | awk 'BEGIN { getline; print toupper($0) }' | sed 's/[^[:alnum:]\r\t]/_/g')
 
     MACRO_PREFIX="${BUILD_LOCK#_}"
     MACRO_PREFIX="${MACRO_PREFIX%%_*}"
 
     # Modify the tmp version file
     {   echo "/**";
-        echo " * @file $BASENAME";
-        echo " * @brief version information of project build";
+        echo " * @file $OUTPUT_FILE_NAME";
+        echo " * @brief This file declares the firmware revision information";
         echo " *";
-        echo " * Generated with $REVER_SCRIPT_NAME $REVER_VERSION";
-        echo " * $REVER_INTRO_L1";
-        echo " * $REVER_INTRO_L2";
-        echo " * $REVER_INTRO_L3";
+        echo " * Generated with $PROJECT_VERSION_SCRIPT_NAME $PROJECT_VERSION_VERSION";
+        echo " * $PROJECT_VERSION_INTRO_L1";
+        echo " * $PROJECT_VERSION_INTRO_L2";
+        echo " * $PROJECT_VERSION_INTRO_L3";
         echo " *";
         echo " * Do not edit this file manually. Its content";
-        echo " * is generated with rever.sh script.";
+        echo " * is generated with project-version.sh script.";
         echo " */";
         echo "#ifndef ${BUILD_LOCK}__";
         echo "#define ${BUILD_LOCK}__";
@@ -304,17 +313,17 @@ if [ "$OUTPUT_FILE_FORMAT" = "base" ]; then
         echo "#define ""$MACRO_PREFIX""_BUILD_HOUR                $HOUR";
         echo "";
         echo "#endif /* ${BUILD_LOCK}__ */";
-    } > "${FILE_PATH}_tmp${EXTENSION}"
+    } > "${FORMATED_OUTPUT_FILE_PATH}_tmp${OUTPUT_FILE_EXTENSION}"
 fi
 
-if cmp -s "${FILE_PATH}" "${FILE_PATH}_tmp${EXTENSION}"
+if cmp -s "${FORMATED_OUTPUT_FILE_PATH}" "${FORMATED_OUTPUT_FILE_PATH}_tmp${OUTPUT_FILE_EXTENSION}"
 then
     # New file and previous one are identical. No need to rewrite it
-    rm "${FILE_PATH}_tmp${EXTENSION}"
-    echo "==> \"$FILE_PATH\" unchanged: $TAG_PREFIX$FW_MAJOR.$FW_MINOR.$FW_PATCH (sha: $COMMIT_SHA)"
+    rm "${FORMATED_OUTPUT_FILE_PATH}_tmp${OUTPUT_FILE_EXTENSION}"
+    echo "==> \"$FORMATED_OUTPUT_FILE_PATH\" unchanged: $GIT_TAG_PREFIX$FW_MAJOR.$FW_MINOR.$FW_PATCH (sha: $COMMIT_SHA)"
     exit 0 # exit with the success code
 else
-    mv "${FILE_PATH}_tmp${EXTENSION}" "${FILE_PATH}"
-    echo "==> \"$FILE_PATH\" updated: $TAG_PREFIX$FW_MAJOR.$FW_MINOR.$FW_PATCH (sha: $COMMIT_SHA)"
+    mv "${FORMATED_OUTPUT_FILE_PATH}_tmp${OUTPUT_FILE_EXTENSION}" "${FORMATED_OUTPUT_FILE_PATH}"
+    echo "==> \"$FORMATED_OUTPUT_FILE_PATH\" updated: $GIT_TAG_PREFIX$FW_MAJOR.$FW_MINOR.$FW_PATCH (sha: $COMMIT_SHA)"
     exit 0 # exit with the success code
 fi
\ No newline at end of file
diff --git a/test/check_rever_version.sh b/test/check_script_self_version.sh
similarity index 82%
rename from test/check_rever_version.sh
rename to test/check_script_self_version.sh
index d188773..b6d39a8 100755
--- a/test/check_rever_version.sh
+++ b/test/check_script_self_version.sh
@@ -16,7 +16,7 @@ if [ -z "$FILE2" ]; then
     exit 1
 fi
 
-# Function to extract values from rever.sh script
+# Function to extract values from project-version.sh script
 extract_from_script() {
     var_name=$1
     grep "^$var_name" "$FILE1" | cut -d '=' -f 2 | tr -d ' \t'
@@ -28,10 +28,10 @@ extract_from_header() {
     grep "^#define[ \t]\+$var_name" "$FILE2" | awk '{print $3}'
 }
 
-# Extract values from rever.sh script
-VERSION_MAJOR_FILE1=$(extract_from_script "REVER_MAJOR")
-VERSION_MINOR_FILE1=$(extract_from_script "REVER_MINOR")
-VERSION_PATCH_FILE1=$(extract_from_script "REVER_PATCH")
+# Extract values from project-version.sh script
+VERSION_MAJOR_FILE1=$(extract_from_script "PROJECT_VERSION_MAJOR")
+VERSION_MINOR_FILE1=$(extract_from_script "PROJECT_VERSION_MINOR")
+VERSION_PATCH_FILE1=$(extract_from_script "PROJECT_VERSION_PATCH")
 
 # Extract values from generated header file
 VERSION_MAJOR_FILE2=$(extract_from_header "VERSION_MAJOR")