Add yamllint CI and codespell CI

LedgerHQ · Apr 3, 2024 · 48326bb · 48326bb
1 parent 5f9bcb1
commit 48326bb
Show file tree

Hide file tree

Showing 5 changed files with 83 additions and 38 deletions.
diff --git a/.github/workflows/codeql_checks.yml b/.github/workflows/codeql_checks.yml
@@ -18,9 +18,9 @@ jobs:
     name: Analyse
     strategy:
       matrix:
-        sdk: [ "$NANOS_SDK", "$NANOX_SDK", "$NANOSP_SDK", "$STAX_SDK" ]
-        #'cpp' covers C and C++
-        language: [ 'cpp' ]
+        sdk: ["$NANOS_SDK", "$NANOX_SDK", "$NANOSP_SDK", "$STAX_SDK"]
+        # 'cpp' covers C and C++
+        language: ['cpp']
     runs-on: ubuntu-latest
     container:
       image: ghcr.io/ledgerhq/ledger-app-builder/ledger-app-builder-legacy:latest

diff --git a/.github/workflows/python-client.yml b/.github/workflows/python-client.yml
@@ -44,37 +44,37 @@ jobs:
     needs: [lint, mypy]
     steps:
 
-    - name: Clone
-      uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
+      - name: Clone
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
-    - name: Build Python package
-      run: |
-        pip install --upgrade pip build twine
-        cd client/
-        python -m build;
-        python -m twine check dist/*
-        pip install .;
-        echo "TAG_VERSION=$(python -c 'from ledger_app_clients.ethereum import __version__; print(__version__)')" >> "$GITHUB_ENV"
+      - name: Build Python package
+        run: |
+          pip install --upgrade pip build twine
+          cd client/
+          python -m build;
+          python -m twine check dist/*
+          pip install .;
+          echo "TAG_VERSION=$(python -c 'from ledger_app_clients.ethereum import __version__; print(__version__)')" >> "$GITHUB_ENV"
 
-    - name: Check version against CHANGELOG
-      if: startsWith(github.ref, 'refs/tags/')
-      run: |
-        CHANGELOG_VERSION=$(grep -Po '(?<=## \[)(\d+\.)+[^\]]' client/CHANGELOG.md | head -n 1)
-        if [ "${{ env.TAG_VERSION }}" == "${CHANGELOG_VERSION}" ];
-        then
-            echo 'Package and CHANGELOG versions match!';
-            exit 0;
-        else
-            echo "Tag '${{ env.TAG_VERSION }}' and CHANGELOG '${CHANGELOG_VERSION}' versions mismatch!";
-            exit 1;
-        fi
+      - name: Check version against CHANGELOG
+        if: startsWith(github.ref, 'refs/tags/')
+        run: |
+          CHANGELOG_VERSION=$(grep -Po '(?<=## \[)(\d+\.)+[^\]]' client/CHANGELOG.md | head -n 1)
+          if [ "${{ env.TAG_VERSION }}" == "${CHANGELOG_VERSION}" ];
+          then
+              echo 'Package and CHANGELOG versions match!';
+              exit 0;
+          else
+              echo "Tag '${{ env.TAG_VERSION }}' and CHANGELOG '${CHANGELOG_VERSION}' versions mismatch!";
+              exit 1;
+          fi
 
-    - name: Publish Python package on pypi.org
-      if: success() && github.event_name == 'push'
-      run: (cd client && python -m twine upload --verbose dist/*)
-      env:
-        TWINE_USERNAME: __token__
-        TWINE_PASSWORD: ${{ secrets.PYPI_PUBLIC_API_TOKEN  }}
-        TWINE_NON_INTERACTIVE: 1
+      - name: Publish Python package on pypi.org
+        if: success() && github.event_name == 'push'
+        run: (cd client && python -m twine upload --verbose dist/*)
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_PUBLIC_API_TOKEN  }}
+          TWINE_NON_INTERACTIVE: 1
diff --git a/.github/workflows/scripts_checking.yml b/.github/workflows/scripts_checking.yml
@@ -0,0 +1,30 @@
+name: Scripts quality CI
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+      - main
+      - develop
+  pull_request:
+
+jobs:
+  misspell:
+    name: Check misspellings
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check misspellings
+        uses: codespell-project/actions-codespell@v1
+        with:
+          builtin: clear,rare
+          check_filenames: true
+          path: src, src_bagl, src_common, src_features, src_nbgl, src_plugin_sdk, src_plugins, doc
+
+  yamllint:
+    name: Check yaml files
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: yamllint .
diff --git a/.yamllint.yml b/.yamllint.yml
@@ -0,0 +1,7 @@
+---
+extends: default
+
+rules:
+  document-start: disable
+  line-length: disable
+  truthy: disable
diff --git a/src_nbgl/ui_settings.c b/src_nbgl/ui_settings.c
@@ -34,19 +34,25 @@ static bool navCallback(uint8_t page, nbgl_pageContent_t* content) {
             switches[index++] =
                 (nbgl_layoutSwitch_t){.initState = N_storage.dataAllowed ? ON_STATE : OFF_STATE,
                                       .text = "Blind signing",
-                                      .subText = "Enable transaction blind\nsigning",
+                                      .subText =
+                                            "Enable transaction blind\n"
+                                            "signing",
                                       .token = BLIND_SIGNING_TOKEN,
                                       .tuneId = TUNE_TAP_CASUAL};
             switches[index++] =
                 (nbgl_layoutSwitch_t){.initState = N_storage.contractDetails ? ON_STATE : OFF_STATE,
                                       .text = "Debug",
-                                      .subText = "Display contract data\ndetails",
+                                      .subText =
+                                            "Display contract data\n"
+                                            "details",
                                       .token = DEBUG_TOKEN,
                                       .tuneId = TUNE_TAP_CASUAL};
             switches[index++] =
                 (nbgl_layoutSwitch_t){.initState = N_storage.displayNonce ? ON_STATE : OFF_STATE,
                                       .text = "Nonce",
-                                      .subText = "Display account nonce\nin transaction",
+                                      .subText =
+                                            "Display account nonce\n"
+                                            "in transaction",
                                       .token = NONCE_TOKEN,
                                       .tuneId = TUNE_TAP_CASUAL};
 
@@ -60,7 +66,9 @@ static bool navCallback(uint8_t page, nbgl_pageContent_t* content) {
             switches[index++] =
                 (nbgl_layoutSwitch_t){.initState = N_storage.verbose_eip712 ? ON_STATE : OFF_STATE,
                                       .text = "Verbose EIP712",
-                                      .subText = "Ignore filtering and\ndisplay raw content",
+                                      .subText =
+                                          "Ignore filtering and\n"
+                                          "display raw content",
                                       .token = EIP712_VERBOSE_TOKEN,
                                       .tuneId = TUNE_TAP_CASUAL};
 #endif  // HAVE_EIP712_FULL_SUPPORT