From 7bdcac2b1d5af4ce63acc1f754eb41cde3087e90 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 | 61 +++++++++++++++++++++++++++------------- cspell.config.yaml | 22 +++++++++++++++ 3 files changed, 72 insertions(+), 19 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 65de332..7f8ba82 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 @@ -32,14 +32,14 @@ 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-with-default-config: runs-on: ubuntu-latest steps: - name: Clone This Repo - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Build run: | cmake -S test -B build/ \ @@ -50,42 +50,42 @@ jobs: 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-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 @@ -99,11 +99,34 @@ jobs: memory_statistics: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 with: - submodules: 'recursive' + submodules: "recursive" - 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 + 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 + + verify-manifest: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + 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 fffb321257638f1306cf836e55f9cf78cbbfc4fe Mon Sep 17 00:00:00 2001 From: Soren Ptak Date: Fri, 25 Aug 2023 11:12:25 -0700 Subject: [PATCH 2/9] Use cSpell spell check, and use ubuntu-20.04 for formatting check --- .github/.cSpellWords.txt | 14 +++ .github/workflows/ci.yml | 4 +- lexicon.txt | 85 ------------------- .../README.md | 2 +- .../FleetProvisioning_MatchTopic/README.md | 2 +- 5 files changed, 18 insertions(+), 89 deletions(-) delete mode 100644 lexicon.txt diff --git a/.github/.cSpellWords.txt b/.github/.cSpellWords.txt index 158bf07..8e58785 100644 --- a/.github/.cSpellWords.txt +++ b/.github/.cSpellWords.txt @@ -1,8 +1,22 @@ +CBMC +CBOR CMOCK CMock Cmock Coverity +DDisable +DNDEBUG +DUNITY MISRA +MQTT Misra +Wunused +cbmc +cbor +cmock coverity +ctest +lcov misra +sinclude +utest diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 7f8ba82..2fa6337 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -69,11 +69,11 @@ 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/lexicon.txt b/lexicon.txt deleted file mode 100644 index 5cdecec..0000000 --- a/lexicon.txt +++ /dev/null @@ -1,85 +0,0 @@ -api -apis -app -aws -br -bufferlength -ca -cbor -cert -com -cond -config -configpagestyle -const -copydoc -createcertificatefromcsr -createkeysandcertificate -css -defgroup -developerguide -doxygen -endcode -endcond -endif -fleetprovisioningaccepted -fleetprovisioningbadparameter -fleetprovisioningbuffertoosmall -fleetprovisioningerror -fleetprovisioninginvalidtopic -fleetprovisioningjson -fleetprovisioningnomatch -fleetprovisioningsuccess -fleetprovjsoncreatecertfromcsraccepted -fleetprovjsoncreatecertfromcsrrejected -gcc -github -html -https -inc -ingroup -iot -iso -json -logdebug -logerror -loginfo -logwarn -mainpage -matchlength -matchstring -md -mdash -memcpy -misra -mit -mqtt -noninfringement -param -pbuffer -pbuffercursor -pem -png -posix -poutapi -poutlength -pouttemplatenamelength -pre -premainingbuffer -premaininglength -premainingtopic -ptemplatename -ptopic -ptopicbuffer -ptopiccursor -registerthing -remaininglength -ret -sdk -spdx -sizeof -sublicense -templatename -templatenamelength -topiclength -wo diff --git a/test/cbmc/proofs/FleetProvisioning_GetRegisterThingTopic/README.md b/test/cbmc/proofs/FleetProvisioning_GetRegisterThingTopic/README.md index 288de05..19e04ce 100644 --- a/test/cbmc/proofs/FleetProvisioning_GetRegisterThingTopic/README.md +++ b/test/cbmc/proofs/FleetProvisioning_GetRegisterThingTopic/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/FleetProvisioning_MatchTopic/README.md b/test/cbmc/proofs/FleetProvisioning_MatchTopic/README.md index 40bb5ae..3f7cdba 100644 --- a/test/cbmc/proofs/FleetProvisioning_MatchTopic/README.md +++ b/test/cbmc/proofs/FleetProvisioning_MatchTopic/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. From 794f9fc05446e38061250254d27a21d62c7fb7cc Mon Sep 17 00:00:00 2001 From: Soren Ptak Date: Wed, 30 Aug 2023 15:29:06 -0700 Subject: [PATCH 3/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 ae9a658204f07539a69d3d0f730dcbe70368ee3b Mon Sep 17 00:00:00 2001 From: Soren Ptak Date: Thu, 31 Aug 2023 14:19:22 -0700 Subject: [PATCH 4/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 853bf0cbb92adf35b34154ca6c1551789acdab08 Mon Sep 17 00:00:00 2001 From: Soren Ptak Date: Fri, 1 Sep 2023 09:31:48 -0700 Subject: [PATCH 5/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 2fa6337..ec602ce 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 build-with-default-config: @@ -52,7 +52,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: ./ doxygen: @@ -126,7 +126,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 7928b8aef10585e48f7dcc1a754171a453c89258 Mon Sep 17 00:00:00 2001 From: Soren Ptak Date: Fri, 1 Sep 2023 18:22:11 -0700 Subject: [PATCH 6/9] Use merged mainline version of formatting --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index ec602ce..d1724f4 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -77,7 +77,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: ./ git-secrets: From de18da962ba35ec71529235a353a80af7ee0d85e Mon Sep 17 00:00:00 2001 From: Soren Ptak Date: Sat, 2 Sep 2023 16:09:32 -0700 Subject: [PATCH 7/9] Update the README file --- README.md | 65 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 37 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 338761a..ae5ce5f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # AWS IoT Fleet Provisioning Library +**[API Documentation Pages for current and previous releases of this library can be found here](https://aws.github.io/Fleet-Provisioning-for-AWS-IoT-embedded-sdk/)** + The Fleet Provisioning library enables you to provision IoT devices without device certificates using the [Fleet Provisioning feature of AWS IoT Core][a1]. For an overview of provisioning options available, see [Device @@ -7,15 +9,16 @@ provisioning][a2]. This library has no dependencies on any additional libraries other than the standard C library, and therefore, can be used with any MQTT library. This library is distributed under the [MIT Open Source License][a3]. -[a1]: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html +[a1]: + https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html [a2]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-provision.html [a3]: LICENSE -This library has gone through code quality checks including verification that -no function has a [GNU Complexity][a4] score over 8, and checks against -deviations from mandatory rules in the [MISRA coding standard][a5]. Deviations -from the MISRA C:2012 guidelines are documented under [MISRA Deviations][a6]. -This library has also undergone static code analysis using [Coverity static +This library has gone through code quality checks including verification that no +function has a [GNU Complexity][a4] score over 8, and checks against deviations +from mandatory rules in the [MISRA coding standard][a5]. Deviations from the +MISRA C:2012 guidelines are documented under [MISRA Deviations][a6]. This +library has also undergone static code analysis using [Coverity static analysis][a7], and validation of memory safety through the [CBMC automated reasoning tool][a8]. @@ -29,33 +32,35 @@ See memory requirements for this library [here][a9]. [a9]: ./docs/doxygen/include/size_table.md -**AWS IoT Fleet Provisioning Library v1.1.0 [source code](https://github.com/aws/Fleet-Provisioning-for-AWS-IoT-embedded-sdk/tree/v1.1.0/source) is part of the [FreeRTOS 202210.00 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202210.00-LTS) release.** - +**AWS IoT Fleet Provisioning Library v1.1.0 +[source code](https://github.com/aws/Fleet-Provisioning-for-AWS-IoT-embedded-sdk/tree/v1.1.0/source) +is part of the +[FreeRTOS 202210.00 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202210.00-LTS) +release.** ## AWS IoT Fleet Provisioning Library Config File -The AWS IoT Fleet Provisioning Library exposes build configuration -macros that are required for building the library. A list of all the -configurations and their default values are defined in -[fleet\_provisioning\_config\_defaults.h][b1]. To provide custom values for the -configuration macros, a config file named `fleet_provisioning_config.h` can be -provided by the application to the library. +The AWS IoT Fleet Provisioning Library exposes build configuration macros that +are required for building the library. A list of all the configurations and +their default values are defined in [fleet_provisioning_config_defaults.h][b1]. +To provide custom values for the configuration macros, a config file named +`fleet_provisioning_config.h` can be provided by the application to the library. [b1]: source/include/fleet_provisioning_config_defaults.h -By default, a `fleet_provisioning_config.h` config file is required to build -the library. To disable this requirement and build the library with default -configuration values, provide `FLEET_PROVISIONING_DO_NOT_USE_CUSTOM_CONFIG` as -a compile time preprocessor macro. +By default, a `fleet_provisioning_config.h` config file is required to build the +library. To disable this requirement and build the library with default +configuration values, provide `FLEET_PROVISIONING_DO_NOT_USE_CUSTOM_CONFIG` as a +compile time preprocessor macro. **Thus, the Fleet Provisioning library can be built by either**: -* Defining a `fleet_provisioning_config.h` file in the application, and adding +- Defining a `fleet_provisioning_config.h` file in the application, and adding it to the include directories list of the library. **OR** -* Defining the `FLEET_PROVISIONING_DO_NOT_USE_CUSTOM_CONFIG` preprocessor macro +- Defining the `FLEET_PROVISIONING_DO_NOT_USE_CUSTOM_CONFIG` preprocessor macro for the library build. ## Building the Library @@ -81,8 +86,8 @@ library target in [test/CMakeLists.txt][c2] file. ### Platform Prerequisites - For running unit tests: - - **C90 compiler** like gcc. - - **CMake 3.13.0 or later**. + - **C90 compiler** like gcc. + - **CMake 3.13.0 or later**. - For running the coverage target, **gcov** and **lcov** are additionally required. @@ -90,7 +95,7 @@ library target in [test/CMakeLists.txt][c2] file. 1. Go to the root directory of this repository. -1. Run the *cmake* command: +1. Run the _cmake_ command: `cmake -S test -B build -DBUILD_CLONE_SUBMODULES=ON`. 1. Run this command to build the library and unit tests: `make -C build all`. @@ -101,11 +106,14 @@ library target in [test/CMakeLists.txt][c2] file. ## CBMC -To learn more about CBMC and proofs specifically, review the training material [here](https://model-checking.github.io/cbmc-training). +To learn more about CBMC and proofs specifically, review the training material +[here](https://model-checking.github.io/cbmc-training). The `test/cbmc/proofs` directory contains CBMC proofs. -In order to run these proofs you will need to install CBMC and other tools by following the instructions [here](https://model-checking.github.io/cbmc-training/installation.html). +In order to run these proofs you will need to install CBMC and other tools by +following the instructions +[here](https://model-checking.github.io/cbmc-training/installation.html). ## Reference examples @@ -113,12 +121,13 @@ The [AWS IoT Embedded C-SDK repository][e1] contains a demo showing the use of the AWS IoT Fleet Provisioning Library on a POSIX platform [here][e2]. [e1]: https://github.com/aws/aws-iot-device-sdk-embedded-C -[e2]: https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/main/demos/fleet_provisioning/fleet_provisioning_with_csr +[e2]: + https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/main/demos/fleet_provisioning/fleet_provisioning_with_csr ## Generating documentation -The Doxygen references were created using Doxygen version 1.9.2. To generate -the Doxygen pages, please run the following command from the root of this +The Doxygen references were created using Doxygen version 1.9.2. To generate the +Doxygen pages, please run the following command from the root of this repository: ```sh From 8f94ee02d9373663cec4a4c51ec6352467d30d8c 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 19fb245c35168cd639f3ca89aebc6997ecaeb116 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 | 8 ++++---- .github/workflows/formatting.yml | 2 +- .github/workflows/release.yml | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d1724f4..370a67a 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: ./ spell-check: @@ -69,7 +69,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: ./ formatting: @@ -103,7 +103,7 @@ jobs: with: submodules: "recursive" - 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 @@ -115,7 +115,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 verify-manifest: runs-on: ubuntu-latest 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 33f9a9e..0fed646 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: Fleet-Provisioning-for-AWS-IoT-embedded-sdk