Merge branch 'FreeRTOS:main' into main

.github/.cSpellWords.txt

@@ -0,0 +1,47 @@
+cbmc
+CBMC
+cbor
+CBOR
+cmock
+Cmock
+CMock
+CMOCK
+coremqtt
+coverity
+Coverity
+CSDK
+ctest
+DCMOCK
+DCOV
+decihours
+Decihours
+DECIHOURS
+DNDEBUG
+DUNITY
+getpacketid
+isystem
+lcov
+misra
+Misra
+MISRA
+MQTT
+mypy
+nondet
+Nondet
+NONDET
+pylint
+pytest
+pyyaml
+sinclude
+UNACKED
+unpadded
+Unpadded
+UNPADDED
+UNSUB
+UNSUBACK
+unsubscriptions
+utest
+vect
+Vect
+VECT
+Wunused

.github/CODEOWNERS

@@ -0,0 +1,37 @@
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# @global-owner1 and @global-owner2 will be requested for
+# review when someone opens a pull request.
+*      @FreeRTOS/pr-bar-raiser
+
+# Order is important; the last matching pattern takes the most
+# precedence. When someone opens a pull request that only
+# modifies JS files, only @js-owner and not the global
+# owner(s) will be requested for a review.
+# *.c FreeRTOS/pr-bar-raiser
+
+# You can also use email addresses if you prefer. They'll be
+# used to look up users just like we do for commit author
+# emails.
+# *.go [email protected]
+
+# In this example, @doctocat owns any files in the build/logs
+# directory at the root of the repository and any of its
+# subdirectories.
+# /build/logs/ @doctocat
+
+# The `docs/*` pattern will match files like
+# `docs/getting-started.md` but not further nested files like
+# `docs/build-app/troubleshooting.md`.
+# docs/*  [email protected]
+
+# In this example, @octocat owns any file in an apps directory
+# anywhere in your repository.
+# apps/ @octocat
+
+# In this example, @doctocat owns any file in the `/docs`
+# directory in the root of your repository and any of its
+# subdirectories.
+# /docs/ @doctocat

.github/pull_request_template.md

@@ -0,0 +1,22 @@
+<!--- Title -->
+
+Description
+-----------
+<!--- Describe your changes in detail. -->
+
+Test Steps
+-----------
+<!-- Describe the steps to reproduce. -->
+
+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! -->
+- [ ] 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/ci.yml

@@ -10,14 +10,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Clone This Repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Build
         run: |
           sudo apt-get install -y lcov sed
           cmake -S test -B build/ \
           -G "Unix Makefiles" \
           -DCMAKE_BUILD_TYPE=Debug \
-          -DBUILD_UNIT_TESTS=ON \
+          -DUNITTEST=ON \
+          -DBUILD_CLONE_SUBMODULES=ON \
           -DCMAKE_C_FLAGS='--coverage -Wall -Wextra -Werror'
           make -C build/ all
       - name: Test
@@ -34,55 +35,61 @@ jobs:
       - name: Check Coverage
         uses: FreeRTOS/CI-CD-Github-Actions/coverage-cop@main
         with:
-          path: ./build/coverage.info
+          coverage-file: ./build/coverage.info
+
   build-code-example:
     runs-on: ubuntu-latest
     steps:
       - name: Clone This Repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Build code example
         run: |
           cmake -S test -B Build -DBUILD_CODE_EXAMPLE=ON
           make -C Build code_example_posix -j8
+
   complexity:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Check complexity
         uses: FreeRTOS/CI-CD-Github-Actions/complexity@main
         with:
           path: ./
+
   doxygen:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Run doxygen build
         uses: FreeRTOS/CI-CD-Github-Actions/doxygen@main
         with:
           path: ./
+
   spell-check:
     runs-on: ubuntu-latest
     steps:
       - name: Clone This Repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Run spellings check
         uses: FreeRTOS/CI-CD-Github-Actions/spellings@main
         with:
           path: ./
+
   formatting:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Check formatting
         uses: FreeRTOS/CI-CD-Github-Actions/formatting@main
         with:
           path: ./
+
   git-secrets:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Checkout awslabs/git-secrets
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           repository: awslabs/git-secrets
           ref: master
@@ -93,32 +100,66 @@ jobs:
         run: |
           git-secrets --register-aws
           git-secrets --scan
+
   custom-standard-c-header:
     runs-on: ubuntu-latest
     steps:
       - name: Clone This Repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Build
         run: |
           mkdir -p override-include
           cp source/include/stdint.readme override-include/stdint.h
           cmake -S test -B build/ \
           -G "Unix Makefiles" \
-          -DBUILD_CLONE_SUBMODULES=ON \
+          -DCOV_ANALYSIS=ON \
           -DCMAKE_C_FLAGS='-Wall -Wextra -Werror -I../override-include'
           make -C build/ coverity_analysis
+
   memory_statistics:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
-            submodules: 'recursive'
+          submodules: "recursive"
       - name: Install Python3
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
         with:
-          python-version: '3.7.10'
+          python-version: "3.11.0"
       - name: Measure sizes
         uses: FreeRTOS/CI-CD-Github-Actions/memory_statistics@main
         with:
-            config: .github/memory_statistics_config.json
-            check_against: docs/doxygen/include/size_table.md
+          config: .github/memory_statistics_config.json
+          check_against: docs/doxygen/include/size_table.md
+
+  link-verifier:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Check Links
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: FreeRTOS/CI-CD-Github-Actions/link-verifier@main
+        with:
+          path: ./
+
+  verify-manifest:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+          fetch-depth: 0
+
+      # At time of writing the gitmodules are set not to pull
+      # Even when using fetch submodules. Need to run this command
+      # To force it to grab them.
+      - name: Perform Recursive Clone
+        shell: bash
+        run: git submodule update --checkout --init --recursive
+
+      - name: Run manifest verifier
+        uses: FreeRTOS/CI-CD-GitHub-Actions/manifest-verifier@main
+        with:
+          path: ./
+          fail-on-incorrect-version: true

.github/workflows/formatting.yml

@@ -0,0 +1,23 @@
+name: Format Pull Request Files
+
+on:
+  issue_comment:
+    types: [created]
+
+env:
+  bashPass: \033[32;1mPASSED -
+  bashInfo: \033[33;1mINFO -
+  bashFail: \033[31;1mFAILED -
+  bashEnd:  \033[0m
+
+jobs:
+  Formatting:
+    name: Run Formatting Check
+    if: ${{ github.event.issue.pull_request &&
+        ( ( github.event.comment.body == '/bot run uncrustify' ) ||
+          ( github.event.comment.body == '/bot run formatting' ) ) }}
+    runs-on: ubuntu-20.04
+    steps:
+    - name: Apply Formatting Fix
+      uses: FreeRTOS/CI-CD-Github-Actions/formatting-bot@main
+      id: check-formatting

.github/workflows/release.yml

@@ -11,12 +11,12 @@ on:
         required: true
 
 jobs:
-  generate-sbom-and-tag-commit:
+  tag-commit:
     name: Tag commit
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           ref: ${{ github.event.inputs.commit_id }}
       - name: Configure git identity
@@ -53,7 +53,7 @@ jobs:
       - name: Install ZIP tools
         run: sudo apt-get install zip unzip
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           ref: ${{ github.event.inputs.commit_id }}
           path: backoffAlgorithm
@@ -91,7 +91,7 @@ jobs:
           ctest -E system --output-on-failure
           cd ..
       - name: Create artifact of ZIP
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: backoffAlgorithm-${{ github.event.inputs.version_number }}.zip
           path: zip-check/backoffAlgorithm-${{ github.event.inputs.version_number }}.zip
@@ -124,7 +124,7 @@ jobs:
           draft: false
           prerelease: false
       - name: Download ZIP artifact
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v4
         with:
           name: backoffAlgorithm-${{ github.event.inputs.version_number }}.zip
       - name: Upload Release Asset

CHANGELOG.md

@@ -1,6 +1,26 @@
 # Changelog for backoffAlgorithm Library
 
+## v1.4.1 (June 2024)
+
+### Changes
+- Fix doxygen deployment on Github.
+
+## v1.4.0 (May 2024)
+
+### Changes
+- [#51](https://github.com/FreeRTOS/backoffAlgorithm/pull/51) Update MISRA Check Information.
+- [#45](https://github.com/FreeRTOS/backoffAlgorithm/pull/45) Update doxygen version to 1.9.6.
+
+## v1.3.0 (October 2022)
+
+### Changes
+
+- [#38](https://github.com/FreeRTOS/backoffAlgorithm/pull/38) MISRA compliance update
+
 ## v1.2.0 (November 2021)
+
+### Changes
+
 - [#31](https://github.com/FreeRTOS/backoffAlgorithm/pull/31) Update doxygen version for documentation.
 - [#30](https://github.com/FreeRTOS/backoffAlgorithm/pull/30) Add code examples to documentation.
 

MISRA.md

@@ -1,16 +1,21 @@
 # MISRA Compliance
 
-The backoffAlgorithm library files conform to the [MISRA C:2012](https://www.misra.org.uk)
-guidelines, with some noted exceptions. Compliance is checked with Coverity static analysis.
-The specific deviations, suppressed inline, are listed below.
-
-Additionally, [MISRA configuration file](https://github.com/FreeRTOS/backoffAlgorithm/blob/main/tools/coverity/misra.config) contains the project wide deviations.
+The backoffAlgorithm library files conform to the
+[MISRA C:2012](https://www.misra.org.uk) guidelines, with some noted exceptions.
+Compliance is checked with Coverity static analysis. The specific deviations,
+suppressed inline, are listed below.
 
+Additionally,
+[MISRA configuration file](https://github.com/FreeRTOS/backoffAlgorithm/blob/main/tools/coverity/misra.config)
+contains the project wide deviations.
 
 ### Suppressed with Coverity Comments
+
 To find the violation references in the source files run grep on the source code
 with ( Assuming rule 11.4 violation; with justification in point 2 ):
+
 ```
 grep 'MISRA Ref 11.4.2' . -rI
 ```
-*None.*
+
+_None._