Fix all the typos, use new version of CI-CD actions

.github/.cSpellWords.txt

@@ -0,0 +1,97 @@
+ADDR
+ATcmd
+Blox
+C
+CATM
+CBMC
+CCID
+CCLK
+CEDRXS
+CEREG
+CFUN
+CG
+CGMI
+CGMM
+CGMR
+CGP
+CGSN
+CIMI
+CLK
+CMOCK
+CPIN
+CPINREADY
+CRSM
+Cbmc
+Cmock
+Coverity
+Cp
+Cpsms
+EDRX
+EDRXS
+EFHPLM
+Edrx
+Ftesting
+HPLMN
+HSDPA
+HSDPAHSUPA
+HSUPA
+Hplmn
+IMEI
+IMSI
+Imsi
+MISRA
+MQTT
+MSI
+Misra
+Mockv
+Mockx
+NBIOT
+PKTIO
+PSMSettings
+Pkio
+Pktio
+Plmn
+Psreg
+QCCID
+QCFG
+QIND
+QIOPEN
+QIRD
+QIURC
+QP
+QPSMS
+QSIMSTAT
+Quectel
+RDYY
+RSRP
+RSRQ
+Rssi
+UTRAN
+WCDMA
+atlib
+cbmc
+cgreg
+cid
+coverity
+creg
+ctest
+eidrx
+iccid
+imei
+lcov
+misra
+nwscanseq
+onse
+pdpdeact
+pkio
+pktios
+plantuml
+plmn
+rsrp
+rsrq
+sinr
+sms
+ublox
+utest
+utrhf
+utrhfgdghfg

.github/workflows/ci.yml

@@ -4,7 +4,6 @@ env:
   bashInfo: \033[33;1mINFO -
   bashFail: \033[31;1mFAILED -
   bashEnd:  \033[0m
-
 on:
   push:
     branches: ["**"]
@@ -53,7 +52,6 @@ jobs:
           echo "::endgroup::"
           lcov --rc lcov_branch_coverage=1 --list build/coverage.info
           echo -e "${{ env.bashPass }} ${{env.stepName}} ${{ env.bashEnd }}"
-
       - name: Check Coverage
         uses: FreeRTOS/CI-CD-Github-Actions/coverage-cop@v2
         with:
@@ -62,42 +60,45 @@ jobs:
   complexity:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Check complexity - Common
-        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/spellings@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
@@ -108,22 +109,49 @@ jobs:
         run: |
           git-secrets --register-aws
           git-secrets --scan
+
   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
+
+  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
+
+
   proof_ci:
+    if: ${{ github.event.pull_request }}
     runs-on: cbmc_ubuntu-latest_64-core
     steps:
       - name: Set up CBMC runner

.github/workflows/memory_statistics.yml

@@ -10,13 +10,13 @@ jobs:
     steps:
       - uses: actions/checkout@v2
         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
+          config: .github/memory_statistics_config.json
       - name: Upload table
         uses: actions/upload-artifact@v2
         with:
           name: size_table
-          path: size_table.md
+          path: size_table.md

.github/workflows/release.yml

@@ -4,10 +4,10 @@ on:
   workflow_dispatch:
     inputs:
       commit_id:
-        description: 'Commit ID to tag and create a release for'
+        description: "Commit ID to tag and create a release for"
         required: true
       version_number:
-        description: 'Release Version Number (Eg, v1.0.0)'
+        description: "Release Version Number (Eg, v1.0.0)"
         required: true
 
 jobs:
@@ -24,9 +24,11 @@ jobs:
           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 }}
+        run:
+          git checkout -b ${{ github.event.inputs.version_number }} ${{
+          github.event.inputs.commit_id }}
       - name: Generate SBOM
-        uses: FreeRTOS/CI-CD-Github-Actions/sbom-generator@main
+        uses: FreeRTOS/CI-CD-Github-Actions/sbom-generator@v2
         with:
           repo_path: ./
           source_path: ./source
@@ -93,15 +95,19 @@ jobs:
       - name: Create artifact of ZIP
         uses: actions/upload-artifact@v2
         with:
-          name: FreeRTOS-Cellular-Interface-${{ github.event.inputs.version_number }}.zip
-          path: zip-check/FreeRTOS-Cellular-Interface-${{ github.event.inputs.version_number }}.zip
+          name:
+            FreeRTOS-Cellular-Interface-${{ github.event.inputs.version_number
+            }}.zip
+          path:
+            zip-check/FreeRTOS-Cellular-Interface-${{
+            github.event.inputs.version_number }}.zip
   deploy-doxygen:
     needs: tag-commit
     name: Deploy doxygen documentation
     runs-on: ubuntu-latest
     steps:
       - name: Doxygen generation
-        uses: FreeRTOS/CI-CD-Github-Actions/doxygen-generation@main
+        uses: FreeRTOS/CI-CD-Github-Actions/doxygen-generation@v2
         with:
           ref: ${{ github.event.inputs.version_number }}
           add_release: "true"
@@ -120,20 +126,28 @@ 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 FreeRTOS-Cellular-Interface Library.
+          body:
+            Release ${{ github.event.inputs.version_number }} of the
+            FreeRTOS-Cellular-Interface Library.
           draft: false
           prerelease: false
       - name: Download ZIP artifact
         uses: actions/download-artifact@v2
         with:
-          name: FreeRTOS-Cellular-Interface-${{ github.event.inputs.version_number }}.zip
+          name:
+            FreeRTOS-Cellular-Interface-${{ github.event.inputs.version_number
+            }}.zip
       - 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: ./FreeRTOS-Cellular-Interface-${{ github.event.inputs.version_number }}.zip
-          asset_name: FreeRTOS-Cellular-Interface-${{ github.event.inputs.version_number }}.zip
+          asset_path:
+            ./FreeRTOS-Cellular-Interface-${{ github.event.inputs.version_number
+            }}.zip
+          asset_name:
+            FreeRTOS-Cellular-Interface-${{ github.event.inputs.version_number
+            }}.zip
           asset_content_type: application/zip

MISRA.md

@@ -72,7 +72,7 @@ _Ref 21.6.1_
 #### Rule 21.9
 _Ref 21.9.1_
 
-- MISRA C-2012 Rule 21.9 does not allow the use of bsearch. This is becasue of
+- MISRA C-2012 Rule 21.9 does not allow the use of bsearch. This is because of
     unspecified behavior, which relates to the treatment of elements that compare as
     equal, can be avoided by ensuring that the comparison function never returns 0.
     When two elements are otherwise equal, the comparison function could

README.md

@@ -14,7 +14,7 @@
 
 ## Introduction
 
-The Cellular Interface library implement a simple unified [Application Programing Interfaces (APIs)](https://www.freertos.org/Documentation/api-ref/cellular/index.html) that hide the complexity of AT commands. The cellular modems to be interchangeable with the popular options built upon TCP stack and exposes a socket-like interface to C programmers.
+The Cellular Interface library implement a simple unified [Application Programming Interfaces (APIs)](https://www.freertos.org/Documentation/api-ref/cellular/index.html) that hide the complexity of AT commands. The cellular modems to be interchangeable with the popular options built upon TCP stack and exposes a socket-like interface to C programmers.
 
 Most cellular modems implement more or less the AT commands defined by the [3GPP TS v27.007](https://portal.3gpp.org/desktopmodules/Specifications/SpecificationDetails.aspx?specificationId=1515) standard. This project provides an implementation of such standard AT commands in a [reusable common component](https://github.com/FreeRTOS/FreeRTOS-Cellular-Interface/tree/main/source/include/common). The three Cellular libraries in this project all take advantage of that common code. The library for each modem only implements the vendor-specific AT commands, then exposes the complete Cellular API.
 
@@ -88,8 +88,8 @@ FreeRTOS Cellular Interface. The following diagram depicts the relationship of t
 
 Follow these steps to integrate FreeRTOS Cellular Interface into your project:
 1. Clone this repository into your project.
-2. Clone one of the refenerce cellular module implementations ( BG96 / HL7802 / SARA-R4 )
-or create your own cellular module implementaion in your project.
+2. Clone one of the reference cellular module implementations ( BG96 / HL7802 / SARA-R4 )
+or create your own cellular module implementation in your project.
 3. Implement comm interface.
 4. Build these software components with your application and execute.
 

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'
+