Update release action for version number (#297)

<!--- Title -->

Description
-----------
* Update the release action for version number include the following
files
  - docs/doxygen/config.doxyfile - PROJECT_NUMBER
  - manifest.yml file - version
  - source file - version header
  - core_mqtt.h - version number
* Add version number check in "Create ZIP and verify package for release
asset" steps. Including the following
  - docs/doxygen/config.doxyfile - PROJECT_NUMBER
  - manifest.yml file - version
  - source file - version header
  - core_mqtt.h - version number
* Update all the version number to "v2.3.0+" and "\<DEVELOPMENT
BRANCH\>"

Test Steps
-----------
Using release action to create release should update the following
* source/include/core_mqtt.h version number
* source files header version number
* doxygen version number
* manifest.yml number
* SBOM file

Tested in personal fork without problem :
https://github.com/FreshDevGo/coreMQTT/actions/runs/9885707328/job/27304218049

Test with wrong source file version number :
https://github.com/FreshDevGo/coreMQTT/actions/runs/9885727002/job/27304274003
Test with wrong manifest.yml version number :
https://github.com/FreshDevGo/coreMQTT/actions/runs/9885726029/job/27304270303
Test with wrong doxygen version number :
https://github.com/FreshDevGo/coreMQTT/actions/runs/9885723302/job/27304269170
Test with wrong version number macro in core_mqtt.h :
https://github.com/FreshDevGo/coreMQTT/actions/runs/9885724835/job/27304268841

Checklist:
----------
<!--- Go over all the following points, and put an `x` in all the boxes
that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
- [x] I have tested my changes. No regression in existing tests.
- [ ] ~~I have modified and/or added unit-tests to cover the code
changes in this Pull Request.~~

Related Issue
-----------
<!-- If any, please provide issue ID. -->
By submitting this pull request, I confirm that you can use, modify,
copy, and redistribute this contribution, under the terms of your
choice.

.github/workflows/release.yml

@@ -13,6 +13,13 @@ on:
         description: 'Is this a re-release of existing tag/release? (Default: false)'
         default: 'false'
         required: false
+
+env:
+  repository_compressed_name: ${{ github.event.repository.name }}-${{ github.event.inputs.version_number }}
+  repository_zip_name: ${{ github.event.repository.name }}-${{ github.event.inputs.version_number }}.zip
+  # Source folder list for version number updates
+  source_folder_list: "source test"
+
 jobs:
   clean-existing-tag-and-release:
     if: ${{ github.event.inputs.delete_existing_tag_release == 'true' }}
@@ -22,7 +29,8 @@ jobs:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+
       - name: Check if tag exists
         run: |
           git fetch origin
@@ -31,6 +39,7 @@ jobs:
               echo "Deleting existing tag for $VERSION_NUM"
               git push origin --delete tags/$VERSION_NUM
           fi
+
       - name: Check if release exists
         run: |
           sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-key 23F3D4EA75716059
@@ -42,42 +51,82 @@ jobs:
               echo "Deleting existing release for $VERSION_NUM"
               gh release delete --yes $VERSION_NUM
           fi
+
   add-sbom-and-tag-commit:
     if: ${{ ( github.event.inputs.delete_existing_tag_release == 'true' && success() )  || ( github.event.inputs.delete_existing_tag_release == 'false' && always() ) }}
     needs: clean-existing-tag-and-release
     name: Tag commit
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: ${{ github.event.inputs.commit_id }}
+
       - name: Configure git identity
         run: |
           git config --global user.name ${{ github.actor }}
           git config --global user.email ${{ github.actor }}@users.noreply.github.com
+
       - name: create a new branch that references commit id
         run: git checkout -b ${{ github.event.inputs.version_number }} ${{ github.event.inputs.commit_id }}
+
+      - name: Update version number in source files
+        run: |
+            echo "${{ env.source_folder_list }}" | \
+            xargs -n 1 sh -c \
+            'find $1 -type f \( -name "*.c" -o -name "*.h" \) \
+            -exec sed -i -b -E "0,/^ \* ${{ github.event.repository.name }}/s/^ \* ${{ github.event.repository.name }}.*/ \* ${{ github.event.repository.name }} ${{ github.event.inputs.version_number }}/g" {} +'
+            git add .
+            git commit -m '[AUTO][RELEASE]: Update version number in source files'
+            git push -u origin ${{ github.event.inputs.version_number }}
+
+      - name : Update version number in manifest.yml
+        run: |
+          sed -i -b '0,/^version/s/^version.*/version: "${{ github.event.inputs.version_number }}"/g' ./manifest.yml
+          git add .
+          git commit -m '[AUTO][RELEASE]: Update version number in manifest.yml'
+          git push -u origin ${{ github.event.inputs.version_number }}
+
+      - name : Update version number in doxygen
+        run: |
+          sed -i -b 's/PROJECT_NUMBER *=.*/PROJECT_NUMBER         = ${{ github.event.inputs.version_number }}/g' ./docs/doxygen/config.doxyfile
+          git add .
+          git commit -m '[AUTO][RELEASE]: Update version number in doxygen'
+          git push -u origin ${{ github.event.inputs.version_number }}
+
+      - name : Update MQTT version number macro
+        if: ${{ github.event.repository.name == 'coreMQTT' }}
+        run: |
+          sed -i -b 's/^\#define MQTT_LIBRARY_VERSION .*/\#define MQTT_LIBRARY_VERSION    "${{ github.event.inputs.version_number }}"/g' source/include/core_mqtt.h
+          git add .
+          git commit -m '[AUTO][RELEASE]: Update version number macro in source/include/core_mqtt.h'
+          git push -u origin ${{ github.event.inputs.version_number }}
+
       - name: Generate SBOM
         uses: FreeRTOS/CI-CD-Github-Actions/sbom-generator@main
         with:
           repo_path: ./
           source_path: ./source
+
       - name: commit SBOM file
         run: |
           git add .
           git commit -m 'Update SBOM'
           git push -u origin ${{ github.event.inputs.version_number }}
+
       - name: Tag Commit and Push to remote
         run: |
-          git tag ${{ github.event.inputs.version_number }} -a -m "coreMQTT Library ${{ github.event.inputs.version_number }}"
+          git tag ${{ github.event.inputs.version_number }} -a -m "${{ github.event.repository.name }} Library ${{ github.event.inputs.version_number }}"
           git push origin --tags
+
       - name: Verify tag on remote
         run: |
           git tag -d ${{ github.event.inputs.version_number }}
           git remote update
           git checkout tags/${{ github.event.inputs.version_number }}
           git diff ${{ github.event.inputs.commit_id }} tags/${{ github.event.inputs.version_number }}
+
   create-zip:
     if: ${{ ( github.event.inputs.delete_existing_tag_release == 'true' && success() )  || ( github.event.inputs.delete_existing_tag_release == 'false' && always() ) }}
     needs: add-sbom-and-tag-commit
@@ -86,49 +135,111 @@ jobs:
     steps:
       - name: Install ZIP tools
         run: sudo apt-get install zip unzip
+
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
-          ref: ${{ github.event.inputs.commit_id }}
-          path: coreMQTT
+          ref: ${{ github.event.inputs.version_number }}
+          path: ${{ github.event.repository.name }}
           submodules: recursive
+
       - name: Checkout disabled submodules
         run: |
-          cd coreMQTT
+          cd ${{ github.event.repository.name }}
           git submodule update --init --checkout --recursive
+
       - name: Create ZIP
         run: |
-          zip -r coreMQTT-${{ github.event.inputs.version_number }}.zip coreMQTT -x "*.git*"
+          zip -r ${{ env.repository_zip_name }} ${{ github.event.repository.name }} -x "*.git*"
           ls ./
+
       - name: Validate created ZIP
         run: |
           mkdir zip-check
-          mv coreMQTT-${{ github.event.inputs.version_number }}.zip zip-check
+          mv ${{ env.repository_zip_name }} zip-check
           cd zip-check
-          unzip coreMQTT-${{ github.event.inputs.version_number }}.zip -d coreMQTT-${{ github.event.inputs.version_number }}
-          ls coreMQTT-${{ github.event.inputs.version_number }}
-          diff -r -x "*.git*" coreMQTT-${{ github.event.inputs.version_number }}/coreMQTT/ ../coreMQTT/
+          unzip ${{ env.repository_zip_name }} -d ${{ env.repository_compressed_name }}
+          ls ${{ env.repository_compressed_name }}
+          diff -r -x "*.git*" ${{ env.repository_compressed_name }}/${{ github.event.repository.name }}/ ../${{ github.event.repository.name }}/
           cd ../
+
+      - name: Check version number in source files
+        run: |
+          cd zip-check/${{ env.repository_compressed_name }}/${{ github.event.repository.name }}
+
+          # List all the *.h *.c files in <source_folder_list>
+          SOURCE_FILE_LIST=$( echo "${{ env.source_folder_list }}" | \
+          xargs -n 1 sh -c 'find $1 -type f \( -name "*.c" -o -name "*.h" \)' )
+
+          # List all the files which contain " * <repository_name>.*" in SOURCE_FILE_LIST
+          SOURCE_FILE_WITH_VERSION_LIST=$( grep -l " \* ${{ github.event.repository.name }}.*" $SOURCE_FILE_LIST )
+
+          # Compare the <version_number> with input version number in files in SOURCE_FILE_LIST
+          echo $SOURCE_FILE_WITH_VERSION_LIST | xargs -I{} sh -c \
+          'grep -x " \* ${{ github.event.repository.name }} ${{ github.event.inputs.version_number }}" {} && \
+          echo {} : match ${{ github.event.repository.name }} ${{ github.event.inputs.version_number }} || \
+          { echo "{} : ${{ github.event.repository.name }} ${{ github.event.inputs.version_number }} not found"; exit 255; }'
+
+      - name: Check version number in doxygen
+        run: |
+          cd zip-check/${{ env.repository_compressed_name }}/${{ github.event.repository.name }}
+
+          # find "PROJECT_NUMBER = <version_number>"
+          DOXYGEN_VERSION_NUMBER=$(grep -x "[ ]*PROJECT_NUMBER[ ]*=[ ]*[^ ]*[ ]*" docs/doxygen/config.doxyfile | awk -F= '{gsub(" ","",$2); print $2 }');
+
+          # compare the <version_number> with input version number
+          [[ $DOXYGEN_VERSION_NUMBER == "${{ github.event.inputs.version_number }}" ]] \
+          && echo "config.doxyfile : match ${{ github.event.inputs.version_number }}" \
+          || { echo "config.doxyfile : $DOXYGEN_VERSION_NUMBER doesn't match ${{ github.event.inputs.version_number }}"; exit 255; }
+
+      - name: Check version number in manifest.yml
+        run: |
+          cd zip-check/${{ env.repository_compressed_name }}/${{ github.event.repository.name }}
+
+          # find the first occurence of "version: <version_number>" and comare the <version_number> with input version number
+          MANIFEST_VESION_NUMBER=$( grep -m 1 -E "^version:[ ]*\".*\"[ ]*" manifest.yml | awk -F: '{ gsub(" ","",$2); gsub("\"","",$2); print $2 }' );
+
+          # compare the <version_number> with input version number
+          [[ $MANIFEST_VESION_NUMBER == "${{ github.event.inputs.version_number }}" ]] \
+          && echo "manifest.yml : match ${{ github.event.inputs.version_number }}" \
+          || { echo "manifest.yml : $MANIFEST_VESION_NUMBER doesn't match ${{ github.event.inputs.version_number }}"; exit 255; }
+
+      - name: Check MQTT version number macro in header file
+        if: ${{ github.event.repository.name == 'coreMQTT' }}
+        run: |
+          cd zip-check/${{ env.repository_compressed_name }}/${{ github.event.repository.name }}
+
+          # find "#define MQTT_LIBRARY_VERSION <version_number>" in core_mqtt.h
+          MACRO_VERSION_NUMBER=$(grep -x "^\#define[ ]*MQTT_LIBRARY_VERSION[ ]*\".*\"[ ]*" source/include/core_mqtt.h | awk '{gsub("\"","",$3); print $3 }');
+          
+          # compare the <version_number> with input version number
+          [[ $MACRO_VERSION_NUMBER == "${{ github.event.inputs.version_number }}" ]] \
+          && echo "core_mqtt.h : match ${{ github.event.inputs.version_number }}" \
+          || { echo "core_mqtt.h : $MACRO_VERSION_NUMBER doesn't match ${{ github.event.inputs.version_number }}"; exit 255; }
+
       - name: Build
         run: |
-          cd zip-check/coreMQTT-${{ github.event.inputs.version_number }}/coreMQTT
+          cd zip-check/${{ env.repository_compressed_name }}/${{ github.event.repository.name }}
           sudo apt-get install -y lcov
           cmake -S test -B build/ \
           -G "Unix Makefiles" \
           -DCMAKE_BUILD_TYPE=Debug \
           -DBUILD_CLONE_SUBMODULES=ON \
           -DCMAKE_C_FLAGS='--coverage -Wall -Wextra -Werror -DNDEBUG'
           make -C build/ all
+
       - name: Test
         run: |
-          cd zip-check/coreMQTT-${{ github.event.inputs.version_number }}/coreMQTT/build/
+          cd zip-check/${{ env.repository_compressed_name }}/${{ github.event.repository.name }}/build/
           ctest -E system --output-on-failure
           cd ..
+
       - name: Create artifact of ZIP
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
-          name: coreMQTT-${{ github.event.inputs.version_number }}.zip
-          path: zip-check/coreMQTT-${{ github.event.inputs.version_number }}.zip
+          name: ${{ env.repository_zip_name }}
+          path: zip-check/${{ env.repository_zip_name }}
+
   deploy-doxygen:
     needs: add-sbom-and-tag-commit
     if: ${{ ( github.event.inputs.delete_existing_tag_release == 'true' && success() )  || ( github.event.inputs.delete_existing_tag_release == 'false' && always() ) }}
@@ -140,6 +251,7 @@ jobs:
         with:
           ref: ${{ github.event.inputs.version_number }}
           add_release: "true"
+
   create-release:
     needs:
       - create-zip
@@ -156,20 +268,22 @@ jobs:
         with:
           tag_name: ${{ github.event.inputs.version_number }}
           release_name: ${{ github.event.inputs.version_number }}
-          body: Release ${{ github.event.inputs.version_number }} of the coreMQTT Library.
+          body: Release ${{ github.event.inputs.version_number }} of the ${{ github.event.repository.name }} Library.
           draft: false
           prerelease: false
+
       - name: Download ZIP artifact
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v4
         with:
-          name: coreMQTT-${{ github.event.inputs.version_number }}.zip
+          name: ${{ env.repository_zip_name }}
+
       - name: Upload Release Asset
         id: upload-release-asset
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           upload_url: ${{ steps.create_release.outputs.upload_url }}
-          asset_path: ./coreMQTT-${{ github.event.inputs.version_number }}.zip
-          asset_name: coreMQTT-${{ github.event.inputs.version_number }}.zip
+          asset_path: ./${{ env.repository_zip_name }}
+          asset_name: ${{ env.repository_zip_name }}
           asset_content_type: application/zip

docs/doxygen/config.doxyfile

@@ -48,7 +48,7 @@ PROJECT_NAME           = coreMQTT
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = v2.3.0
+PROJECT_NUMBER         = v2.3.0+
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

manifest.yml

@@ -1,5 +1,5 @@
 name : "coreMQTT"
-version: "v2.3.0"
+version: "v2.3.0+"
 description: |
   "Client implementation of the MQTT 3.1.1 specification for embedded devices.\n"
 license: "MIT"

source/core_mqtt.c

@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.3.0
+ * coreMQTT <DEVELOPMENT BRANCH>
  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT

source/core_mqtt_serializer.c

@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.3.0
+ * coreMQTT <DEVELOPMENT BRANCH>
  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT

source/core_mqtt_state.c

@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.3.0
+ * coreMQTT <DEVELOPMENT BRANCH>
  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT

source/include/core_mqtt.h

@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.3.0
+ * coreMQTT <DEVELOPMENT BRANCH>
  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
@@ -44,8 +44,11 @@
 /**
  * @cond DOXYGEN_IGNORE
  * The current version of this library.
+ *
+ * If MQTT_LIBRARY_VERSION ends with + it represents the version in development
+ * after the numbered release.
  */
-#define MQTT_LIBRARY_VERSION    "v2.1.0"
+#define MQTT_LIBRARY_VERSION    "v2.3.0+"
 /** @endcond */
 
 /**

source/include/core_mqtt_config_defaults.h

@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.3.0
+ * coreMQTT <DEVELOPMENT BRANCH>
  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT

source/include/core_mqtt_serializer.h

@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.3.0
+ * coreMQTT <DEVELOPMENT BRANCH>
  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT

source/include/core_mqtt_state.h

@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.3.0
+ * coreMQTT <DEVELOPMENT BRANCH>
  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT

source/interface/transport_interface.h

@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.3.0
+ * coreMQTT <DEVELOPMENT BRANCH>
  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT

test/cbmc/include/core_mqtt_config.h

@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.3.0
+ * coreMQTT <DEVELOPMENT BRANCH>
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT

test/cbmc/include/event_callback_stub.h

@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.3.0
+ * coreMQTT <DEVELOPMENT BRANCH>
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT

test/cbmc/include/get_time_stub.h

@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.3.0
+ * coreMQTT <DEVELOPMENT BRANCH>
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT

test/cbmc/include/mqtt_cbmc_state.h

@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.3.0
+ * coreMQTT <DEVELOPMENT BRANCH>
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT

test/cbmc/include/network_interface_stubs.h

@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.3.0
+ * coreMQTT <DEVELOPMENT BRANCH>
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT