Add code linter CI

Differential Revision: D68963580 Pull Request resolved: #403
facebookincubator · Feb 1, 2025 · b67ecd8 · b67ecd8
1 parent c68408b
commit b67ecd8
Show file tree

Hide file tree

Showing 5 changed files with 76 additions and 280 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
diff --git a/.github/config/lint/.yaml-lint.yml b/.github/config/lint/.yaml-lint.yml
@@ -0,0 +1,10 @@
+---
+extends: default
+
+rules:
+  # 120 chars should be enough, but don't fail if a line is longer
+  line-length:
+    max: 120
+    level: warning
+  comments:
+    min-spaces-from-content: 2
diff --git a/.github/workflows/build_linux.yaml → .github/workflows/build-linux.yml b/.github/workflows/build_linux.yaml → .github/workflows/build-linux.yml
@@ -1,19 +1,26 @@
+---
 name: CI-Linux
-on:
+
+on: # yamllint disable-line rule:truthy
   push:
     branches:
       - main
   pull_request:
     branches:
       - main
 
+permissions: read-all
+
 jobs:
   build-linux:
     name: build on ubuntu
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        cmake_args: ["", "-DUSE_IBVERBS=ON -DUSE_LIBUV=ON -DUSE_TCP_OPENSSL_LINK=ON", "-DUSE_TCP_OPENSSL_LOAD=ON"]
+        cmake_args:
+          - ""
+          - "-DUSE_IBVERBS=ON -DUSE_LIBUV=ON -DUSE_TCP_OPENSSL_LINK=ON"
+          - "-DUSE_TCP_OPENSSL_LOAD=ON"
 
     steps:
       - name: Checkout code
@@ -24,7 +31,8 @@ jobs:
       - name: Install apt packages
         run: |
           sudo apt-get install -y wget perl build-essential cmake libibverbs-dev libssl-dev
-      - name: Install openssl # TODO: upgrade to latest
+      # TODO: upgrade to latest
+      - name: Install openssl
         run: |
           sudo wget -q https://www.openssl.org/source/openssl-1.1.1b.tar.gz
           sudo tar -xzf openssl-1.1.1b.tar.gz
@@ -44,7 +52,8 @@ jobs:
           sudo make install
       - name: Install googletest
         run: |
-          wget -q -O googletest-release-1.15.2.tar.gz https://github.com/google/googletest/releases/download/v1.15.2/googletest-1.15.2.tar.gz
+          wget -q -O googletest-release-1.15.2.tar.gz \
+            https://github.com/google/googletest/releases/download/v1.15.2/googletest-1.15.2.tar.gz
           tar xf googletest-release-1.15.2.tar.gz
           cd googletest-1.15.2
           mkdir -p build
@@ -57,8 +66,6 @@ jobs:
           sudo apt-get update
           sudo apt install build-essential
           sudo apt-get install -y gcc g++
-          # export CC=gcc-${{ matrix.gcc-version }}
-          # export CXX=g++-${{ matrix.gcc-version }}
           mkdir -p build
           cd build
           cmake ../ -DCMAKE_VERBOSE_MAKEFILE=ON -DBUILD_TEST=ON ${{matrix.cmake_args}} -DOPENSSL_ROOT_DIR=/opt/openssl/

diff --git a/.github/workflows/build.yaml → .github/workflows/build-windows.yml b/.github/workflows/build.yaml → .github/workflows/build-windows.yml
@@ -1,10 +1,15 @@
-name: CI
-on:
+---
+# This runs the windows CI
+name: Windows CI
+
+on: # yamllint disable-line rule:truthy
   push:
     branches:
       - main
   pull_request:
 
+permissions: read-all
+
 jobs:
   windows_build:
     runs-on: windows-latest
@@ -20,12 +25,13 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
       - name: Set up Python 3.10
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
+          python-version: "3.10"
       - name: Add conda to system path
         run: |
-          # $CONDA is an environment variable pointing to the root of the miniconda directory
+          # $CONDA is an environment variable pointing to the root of the
+          # miniconda directory
           echo $CONDA/bin >> $GITHUB_PATH
       - name: Conda info
         shell: bash -l {0}
@@ -49,7 +55,8 @@ jobs:
       - name: Install googletest
         run: |
           conda activate py376_build
-          curl https://codeload.github.com/google/googletest/tar.gz/release-1.10.0 --output googletest-release-1.10.0.tar.gz
+          curl https://codeload.github.com/google/googletest/tar.gz/release-1.10.0 --output `
+            googletest-release-1.10.0.tar.gz
           tar xzvf googletest-release-1.10.0.tar.gz
           cd googletest-release-1.10.0
           mkdir -p build
@@ -68,7 +75,10 @@ jobs:
           git submodule update --init --recursive
           mkdir -p build
           cd build
-          cmake ..  -DBUILD_TEST=ON -Dlibuv_ROOT=${{ env.libuv_path }} -DGTEST_LIBRARY=${{ env.gtest_lib_path }}/lib/gtestd.lib -DGTEST_INCLUDE_DIR=${{ env.gtest_lib_path }}/include -DGTEST_MAIN_LIBRARY=${{ env.gtest_lib_path }}/lib/gtest_maind.lib
+          cmake ..  -DBUILD_TEST=ON -Dlibuv_ROOT=${{ env.libuv_path }} `
+            -DGTEST_LIBRARY=${{ env.gtest_lib_path }}/lib/gtestd.lib `
+            -DGTEST_INCLUDE_DIR=${{ env.gtest_lib_path }}/include `
+            -DGTEST_MAIN_LIBRARY=${{ env.gtest_lib_path }}/lib/gtest_maind.lib
           msbuild ALL_BUILD.vcxproj
       - name: Test
         run: |