From 588be3825b542dbc45fe03a6503df8833641d54b Mon Sep 17 00:00:00 2001 From: Soren Ptak Date: Thu, 24 Aug 2023 15:17:17 -0700 Subject: [PATCH 1/9] Use new version of CI-CD Actions --- .github/.cSpellWords.txt | 8 ++++ .github/workflows/ci.yml | 79 ++++++++++++++++++++++++++++------------ cspell.config.yaml | 22 +++++++++++ 3 files changed, 86 insertions(+), 23 deletions(-) create mode 100644 .github/.cSpellWords.txt create mode 100644 cspell.config.yaml diff --git a/.github/.cSpellWords.txt b/.github/.cSpellWords.txt new file mode 100644 index 0000000..158bf07 --- /dev/null +++ b/.github/.cSpellWords.txt @@ -0,0 +1,8 @@ +CMOCK +CMock +Cmock +Coverity +MISRA +Misra +coverity +misra diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 2698dcf..dd4a620 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -10,7 +10,7 @@ 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 @@ -32,57 +32,63 @@ jobs: echo ${EXCLUDE[@]} | xargs lcov --rc lcov_branch_coverage=1 -r build/coverage.info -o build/coverage.info lcov --rc lcov_branch_coverage=1 --list build/coverage.info - name: Check Coverage - uses: FreeRTOS/CI-CD-Github-Actions/coverage-cop@main + uses: FreeRTOS/CI-CD-Github-Actions/coverage-cop@v2 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 + uses: FreeRTOS/CI-CD-Github-Actions/complexity@v2 with: path: ./ + doxygen: 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 + uses: FreeRTOS/CI-CD-Github-Actions/doxygen@v2 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 + uses: FreeRTOS/CI-CD-GitHub-Actions/rust-spell-check@v2 with: path: ./ + formatting: - runs-on: ubuntu-20.04 + runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Check formatting - uses: FreeRTOS/CI-CD-Github-Actions/formatting@main + uses: FreeRTOS/CI-CD-Github-Actions/formatting@v2 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,11 +99,12 @@ 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 @@ -107,18 +114,44 @@ jobs: -DBUILD_CLONE_SUBMODULES=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.11.0' + python-version: "3.11.0" - name: Measure sizes - uses: FreeRTOS/CI-CD-Github-Actions/memory_statistics@main + uses: FreeRTOS/CI-CD-Github-Actions/memory_statistics@v2 + with: + 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@v2 + with: + path: ./ + + verify-manifest: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 with: - config: .github/memory_statistics_config.json - check_against: docs/doxygen/include/size_table.md + submodules: true + fetch-depth: 0 + + - name: Run manifest verifier + uses: FreeRTOS/CI-CD-GitHub-Actions/manifest-verifier@v2 + with: + path: ./ + fail-on-incorrect-version: true diff --git a/cspell.config.yaml b/cspell.config.yaml new file mode 100644 index 0000000..e7d8a56 --- /dev/null +++ b/cspell.config.yaml @@ -0,0 +1,22 @@ +--- +$schema: https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json +version: '0.2' +# Allows things like stringLength +allowCompoundWords: true +useGitignore: true +# Could split this up? And do a dictionary for each repo? +# But feel like if this isn't super slow +# That having just one single dictionary might be nicer? +dictionaryDefinitions: + - name: freertos-words + path: '.github/.cSpellWords.txt' + addWords: true +dictionaries: + - freertos-words +ignorePaths: + - 'node_modules' + - '.cSpellWords.txt' + - 'dependency' + - 'docs' + - 'ThirdParty' + From 1ca362e5404f708aa91fc7e823ccd037a2065245 Mon Sep 17 00:00:00 2001 From: Soren Ptak Date: Fri, 25 Aug 2023 03:54:22 -0700 Subject: [PATCH 2/9] Use cSpell spell check, and use ubuntu-20.04 for formatting check --- .github/workflows/ci.yml | 4 +- MISRA.md | 17 +++++--- README.md | 92 +++++++++++++++++++++++++++------------- 3 files changed, 76 insertions(+), 37 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index dd4a620..368e16d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -70,12 +70,12 @@ jobs: - name: Clone This Repo uses: actions/checkout@v3 - name: Run spellings check - uses: FreeRTOS/CI-CD-GitHub-Actions/rust-spell-check@v2 + uses: FreeRTOS/CI-CD-GitHub-Actions/spellings@v2 with: path: ./ formatting: - runs-on: ubuntu-latest + runs-on: ubuntu-20.04 steps: - uses: actions/checkout@v3 - name: Check formatting diff --git a/MISRA.md b/MISRA.md index 4f593a0..d265251 100644 --- a/MISRA.md +++ b/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.* \ No newline at end of file + +_None._ diff --git a/README.md b/README.md index b1cf470..db2c885 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,46 @@ ## backoffAlgorithm Library -This repository contains the backoffAlgorithm library, a utility library to calculate backoff period using an exponential backoff with jitter algorithm for retrying network operations (like failed network connection with server). -This library uses the "Full Jitter" strategy for the exponential backoff with jitter algorithm. -More information about the algorithm can be seen in the [Exponential Backoff and Jitter](https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/) AWS blog. +**[API Documentation Pages for current and previous releases of this library can be found here](https://freertos.github.io/backoffAlgorithm/)** -The backoffAlgorithm library is distributed under the [MIT Open Source License](LICENSE). +This repository contains the backoffAlgorithm library, a utility library to +calculate backoff period using an exponential backoff with jitter algorithm for +retrying network operations (like failed network connection with server). This +library uses the "Full Jitter" strategy for the exponential backoff with jitter +algorithm. More information about the algorithm can be seen in the +[Exponential Backoff and Jitter](https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/) +AWS blog. -Exponential backoff with jitter is typically used when retrying a failed network -connection or operation request with the server. An exponential backoff with jitter helps to -mitigate failed network operations with servers, that are caused due to network congestion or high request load on -the server, by spreading out retry requests across multiple devices attempting network operations. -Besides, in an environment with poor connectivity, a client can get disconnected at any time. -A backoff strategy helps the client to conserve battery by not repeatedly attempting reconnections when they are -unlikely to succeed. - -See memory requirements for this library [here](./docs/doxygen/include/size_table.md). +The backoffAlgorithm library is distributed under the +[MIT Open Source License](LICENSE). -**backoffAlgorithm v1.3.0 [source code](https://github.com/FreeRTOS/backoffAlgorithm/tree/v1.3.0/source) is part of the [FreeRTOS 202210.00 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202210.00-LTS) release.** - -**backoffAlgorithm v1.0.0 [source code](https://github.com/FreeRTOS/backoffAlgorithm/tree/v1.0.0/source) is part of the [FreeRTOS 202012.00 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202012.00-LTS) release.** +Exponential backoff with jitter is typically used when retrying a failed network +connection or operation request with the server. An exponential backoff with +jitter helps to mitigate failed network operations with servers, that are caused +due to network congestion or high request load on the server, by spreading out +retry requests across multiple devices attempting network operations. Besides, +in an environment with poor connectivity, a client can get disconnected at any +time. A backoff strategy helps the client to conserve battery by not repeatedly +attempting reconnections when they are unlikely to succeed. + +See memory requirements for this library +[here](./docs/doxygen/include/size_table.md). + +**backoffAlgorithm v1.3.0 +[source code](https://github.com/FreeRTOS/backoffAlgorithm/tree/v1.3.0/source) +is part of the +[FreeRTOS 202210.00 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202210.00-LTS) +release.** + +**backoffAlgorithm v1.0.0 +[source code](https://github.com/FreeRTOS/backoffAlgorithm/tree/v1.0.0/source) +is part of the +[FreeRTOS 202012.00 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202012.00-LTS) +release.** ## Reference example -The example below shows how to use the backoffAlgorithm library on a POSIX platform to retry a DNS resolution query for `amazon.com`. +The example below shows how to use the backoffAlgorithm library on a POSIX +platform to retry a DNS resolution query for `amazon.com`. ```c #include "backoff_algorithm.h" @@ -108,18 +126,25 @@ int main() ## Building the library -A compiler that supports **C90 or later** such as *gcc* is required to build the library. +A compiler that supports **C90 or later** such as _gcc_ is required to build the +library. -Additionally, the library uses a header file introduced in ISO C99, `stdint.h`. For compilers that do not provide this header file, the [source/include](source/include) directory contains [stdint.readme](source/include/stdint.readme), which can be renamed to `stdint.h` to -build the backoffAlgorithm library. +Additionally, the library uses a header file introduced in ISO C99, `stdint.h`. +For compilers that do not provide this header file, the +[source/include](source/include) directory contains +[stdint.readme](source/include/stdint.readme), which can be renamed to +`stdint.h` to build the backoffAlgorithm library. + +For instance, if the example above is copied to a file named `example.c`, _gcc_ +can be used like so: -For instance, if the example above is copied to a file named `example.c`, *gcc* can be used like so: ```bash gcc -I source/include example.c source/backoff_algorithm.c -o example ./example ``` -*gcc* can also produce an output file to be linked: +_gcc_ can also produce an output file to be linked: + ```bash gcc -I source/include -c source/backoff_algorithm.c ``` @@ -127,9 +152,16 @@ gcc -I source/include -c source/backoff_algorithm.c ## Building unit tests ### Checkout Unity Submodule -By default, the submodules in this repository are configured with `update=none` in [.gitmodules](.gitmodules), to avoid increasing clone time and disk space usage of other repositories (like [amazon-freertos](https://github.com/aws/amazon-freertos) that submodules this repository). -To build unit tests, the submodule dependency of Unity is required. Use the following command to clone the submodule: +By default, the submodules in this repository are configured with `update=none` +in [.gitmodules](.gitmodules), to avoid increasing clone time and disk space +usage of other repositories (like +[amazon-freertos](https://github.com/aws/amazon-freertos) that submodules this +repository). + +To build unit tests, the submodule dependency of Unity is required. Use the +following command to clone the submodule: + ``` git submodule update --checkout --init --recursive test/unit-test/Unity ``` @@ -137,17 +169,18 @@ git submodule update --checkout --init --recursive test/unit-test/Unity ### Platform Prerequisites - For running unit tests - - C89 or later compiler like gcc - - CMake 3.13.0 or later + - C89 or later compiler like gcc + - CMake 3.13.0 or later - For running the coverage target, gcov is additionally required. ### Steps to build Unit Tests -1. Go to the root directory of this repository. (Make sure that the **Unity** submodule is cloned as described [above](#checkout-unity-submodule).) +1. Go to the root directory of this repository. (Make sure that the **Unity** + submodule is cloned as described [above](#checkout-unity-submodule).) 1. Create build directory: `mkdir build && cd build` -1. Run *cmake* while inside build directory: `cmake -S ../test` +1. Run _cmake_ while inside build directory: `cmake -S ../test` 1. Run this command to build the library and unit tests: `make all` @@ -157,4 +190,5 @@ git submodule update --checkout --init --recursive test/unit-test/Unity ## Contributing -See [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for information on contributing. +See [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for information on +contributing. From c6b358eec4a7fb90b6795fd74749f36a68bb14ef Mon Sep 17 00:00:00 2001 From: Soren Ptak Date: Fri, 25 Aug 2023 07:48:39 -0700 Subject: [PATCH 3/9] Add in missing words, remove the lexicon --- .github/.cSpellWords.txt | 14 +++++++++ lexicon.txt | 65 ---------------------------------------- 2 files changed, 14 insertions(+), 65 deletions(-) delete mode 100644 lexicon.txt diff --git a/.github/.cSpellWords.txt b/.github/.cSpellWords.txt index 158bf07..33d5993 100644 --- a/.github/.cSpellWords.txt +++ b/.github/.cSpellWords.txt @@ -1,8 +1,22 @@ +CBMC +CBOR CMOCK CMock Cmock Coverity +DNDEBUG +DUNITY MISRA +MQTT Misra +Wunused +cbmc +cbor +cmock coverity +ctest +isystem +lcov misra +sinclude +utest diff --git a/lexicon.txt b/lexicon.txt deleted file mode 100644 index c97a4db..0000000 --- a/lexicon.txt +++ /dev/null @@ -1,65 +0,0 @@ -api -apis -aws -backoff -backoff -backoffalgorithm -backoffalgorithmretriesexhausted -backoffalgorithmrngfailure -backoffalgorithmsuccess -backoffbase -br -colspan -com -copydoc -defgroup -dns -endif -fd -freertos -gcc -getaddrinfo -github -html -https -ifdef -ifndef -inc -ingroup -iot -iso -longjmp -mainpage -maxattempts -maxbackoff -maxretryattempts -md -min -misra -mit -mockrng -noninfringement -os -param -pcontext -pnextbackoff -posix -pretrycontext -pretryparams -prng -rand -randomvalue -readme -rm -rng -sdk -spdx -shouldn -stderr -sublicense -tcp -td -toolchain -tr -trng -usleep From 4d808119c57d8d4b07e1c829bc5a99ee7fcd0445 Mon Sep 17 00:00:00 2001 From: Soren Ptak Date: Wed, 30 Aug 2023 15:29:06 -0700 Subject: [PATCH 4/9] Use the new version of the cspell.config.yaml --- cspell.config.yaml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/cspell.config.yaml b/cspell.config.yaml index e7d8a56..331f137 100644 --- a/cspell.config.yaml +++ b/cspell.config.yaml @@ -4,6 +4,12 @@ version: '0.2' # Allows things like stringLength allowCompoundWords: true useGitignore: true +languageSettings: + - allowCompoundWords: true + caseSensitive: false + enabled: true + languageId: c + locale: "*" # Could split this up? And do a dictionary for each repo? # But feel like if this isn't super slow # That having just one single dictionary might be nicer? @@ -14,9 +20,8 @@ dictionaryDefinitions: dictionaries: - freertos-words ignorePaths: - - 'node_modules' - '.cSpellWords.txt' - 'dependency' - 'docs' - 'ThirdParty' - + - 'History.txt' From 3a164fbaa924305d2c48708a0bf516689a39f850 Mon Sep 17 00:00:00 2001 From: Soren Ptak Date: Thu, 31 Aug 2023 14:19:22 -0700 Subject: [PATCH 5/9] Update the cspell config file to clean it up a bit --- cspell.config.yaml | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/cspell.config.yaml b/cspell.config.yaml index 331f137..911ce1d 100644 --- a/cspell.config.yaml +++ b/cspell.config.yaml @@ -3,24 +3,28 @@ $schema: https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell version: '0.2' # Allows things like stringLength allowCompoundWords: true + +# Read files not to spell check from the git ignore useGitignore: true + +# Language settings for C languageSettings: - - allowCompoundWords: true - caseSensitive: false + - caseSensitive: false enabled: true languageId: c locale: "*" -# Could split this up? And do a dictionary for each repo? -# But feel like if this isn't super slow -# That having just one single dictionary might be nicer? + +# Add a dictionary, and the path to the word list dictionaryDefinitions: - name: freertos-words path: '.github/.cSpellWords.txt' addWords: true + dictionaries: - freertos-words + +# Paths and files to ignore ignorePaths: - - '.cSpellWords.txt' - 'dependency' - 'docs' - 'ThirdParty' From 8bd1b7603b9ed615f22408e8f426f897d92b7954 Mon Sep 17 00:00:00 2001 From: Soren Ptak Date: Fri, 1 Sep 2023 09:31:48 -0700 Subject: [PATCH 6/9] Use merged version of some actions --- .github/workflows/ci.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 368e16d..ac8ac80 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -32,7 +32,7 @@ jobs: echo ${EXCLUDE[@]} | xargs lcov --rc lcov_branch_coverage=1 -r build/coverage.info -o build/coverage.info lcov --rc lcov_branch_coverage=1 --list build/coverage.info - name: Check Coverage - uses: FreeRTOS/CI-CD-Github-Actions/coverage-cop@v2 + uses: FreeRTOS/CI-CD-Github-Actions/coverage-cop@main with: coverage-file: ./build/coverage.info @@ -51,7 +51,7 @@ jobs: steps: - uses: actions/checkout@v3 - name: Check complexity - uses: FreeRTOS/CI-CD-Github-Actions/complexity@v2 + uses: FreeRTOS/CI-CD-Github-Actions/complexity@main with: path: ./ @@ -151,7 +151,7 @@ jobs: fetch-depth: 0 - name: Run manifest verifier - uses: FreeRTOS/CI-CD-GitHub-Actions/manifest-verifier@v2 + uses: FreeRTOS/CI-CD-GitHub-Actions/manifest-verifier@main with: path: ./ fail-on-incorrect-version: true From 896324cb2d8cace17653246d4039fa61ddb6512f Mon Sep 17 00:00:00 2001 From: Soren Ptak Date: Fri, 1 Sep 2023 18:22:11 -0700 Subject: [PATCH 7/9] Use merged mainline version of formatting --- .github/workflows/ci.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index ac8ac80..3514840 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -60,7 +60,7 @@ jobs: steps: - uses: actions/checkout@v3 - name: Run doxygen build - uses: FreeRTOS/CI-CD-Github-Actions/doxygen@v2 + uses: FreeRTOS/CI-CD-Github-Actions/doxygen@main with: path: ./ @@ -79,7 +79,7 @@ jobs: steps: - uses: actions/checkout@v3 - name: Check formatting - uses: FreeRTOS/CI-CD-Github-Actions/formatting@v2 + uses: FreeRTOS/CI-CD-Github-Actions/formatting@main with: path: ./ From 2a664a6f4590208c2a1e76a8c323ed7740e0beb0 Mon Sep 17 00:00:00 2001 From: Soren Ptak Date: Tue, 5 Sep 2023 10:26:26 -0700 Subject: [PATCH 8/9] Add in bot formatting action --- .github/workflows/formatting.yml | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 .github/workflows/formatting.yml diff --git a/.github/workflows/formatting.yml b/.github/workflows/formatting.yml new file mode 100644 index 0000000..f7141e7 --- /dev/null +++ b/.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@v2 + id: check-formatting From 69351191212eae805e9d2dc40d4a073f649aade9 Mon Sep 17 00:00:00 2001 From: Soren Ptak Date: Tue, 5 Sep 2023 13:55:41 -0700 Subject: [PATCH 9/9] Update to use merged mainline actions, use checkout@v3 instead of checkout@v2 on all jobs --- .github/workflows/ci.yml | 6 +++--- .github/workflows/formatting.yml | 2 +- .github/workflows/release.yml | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 3514840..bb303e3 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -70,7 +70,7 @@ jobs: - name: Clone This Repo uses: actions/checkout@v3 - name: Run spellings check - uses: FreeRTOS/CI-CD-GitHub-Actions/spellings@v2 + uses: FreeRTOS/CI-CD-Github-Actions/spellings@main with: path: ./ @@ -126,7 +126,7 @@ jobs: with: python-version: "3.11.0" - name: Measure sizes - uses: FreeRTOS/CI-CD-Github-Actions/memory_statistics@v2 + uses: FreeRTOS/CI-CD-Github-Actions/memory_statistics@main with: config: .github/memory_statistics_config.json check_against: docs/doxygen/include/size_table.md @@ -138,7 +138,7 @@ jobs: - name: Check Links env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - uses: FreeRTOS/CI-CD-Github-Actions/link-verifier@v2 + uses: FreeRTOS/CI-CD-Github-Actions/link-verifier@main with: path: ./ diff --git a/.github/workflows/formatting.yml b/.github/workflows/formatting.yml index f7141e7..8257add 100644 --- a/.github/workflows/formatting.yml +++ b/.github/workflows/formatting.yml @@ -19,5 +19,5 @@ jobs: runs-on: ubuntu-20.04 steps: - name: Apply Formatting Fix - uses: FreeRTOS/CI-CD-Github-Actions/formatting-bot@v2 + uses: FreeRTOS/CI-CD-Github-Actions/formatting-bot@main id: check-formatting diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 22dc9be..7caf605 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -16,7 +16,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout code - uses: actions/checkout@v2 + uses: actions/checkout@v3 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@v3 with: ref: ${{ github.event.inputs.commit_id }} path: backoffAlgorithm