[Tarantool-patches] [PATCH 2/2] ci: enable checkpatch

Sergey Bronnikov estetus at gmail.com
Tue Jul 11 19:51:34 MSK 2023


From: Sergey Bronnikov <sergeyb at tarantool.org>

Patch enables checkpatch [1] for checking patch on a pre-commit stage.
In Tarantool we use our own fork of checkpatch [2] with additional check
types. It's logical to use it in a LuaJIT development. We don't need
check tags in commit messages like NO_DOC, NO_CHANGELOG, NO_TEST and
others, so to be able to customize command-line options Github Action, provided
by checkpatch repository [3], was added to the repository.

See documentation for used checkpatch in [4].

1. https://docs.kernel.org/dev-tools/checkpatch.html
2. https://github.com/tarantool/checkpatch
3. https://github.com/tarantool/checkpatch/blob/master/.github/actions/checkpatch/action.yml
4. https://github.com/tarantool/checkpatch/blob/master/doc/checkpatch.rst
---
 .github/actions/checkpatch/action.yml | 17 +++++++++++++++++
 .github/workflows/lint.yml            | 14 ++++++++++++++
 2 files changed, 31 insertions(+)
 create mode 100644 .github/actions/checkpatch/action.yml

diff --git a/.github/actions/checkpatch/action.yml b/.github/actions/checkpatch/action.yml
new file mode 100644
index 00000000..df2e2a2b
--- /dev/null
+++ b/.github/actions/checkpatch/action.yml
@@ -0,0 +1,17 @@
+name: Checkpatch
+description: Check patches against LuaJIT development guidelines
+inputs:
+  revision-range:
+    description: Git revision range to check
+    required: true
+runs:
+  using: composite
+  steps:
+    - uses: actions/checkout at v3
+      with:
+        repository: tarantool/checkpatch
+        path: 'checkpatch'
+    - run: apt install -y codespell
+      shell: bash
+    - run: checkpatch/checkpatch.pl --codespell --color=always --show-types --git ${{ inputs.revision-range }} --codespellfile /usr/lib/python3/dist-packages/codespell_lib/data/dictionary.txt --ignore NO_CHANGELOG,NO_DOC,NO_TEST,COMMIT_LOG_LONG_LINE
+      shell: bash
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index 71ceee9a..d28aa15b 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -53,3 +53,17 @@ jobs:
       - name: test
         run: cmake --build . --target LuaJIT-luacheck
         working-directory: ${{ env.BUILDDIR }}
+
+  checkpatch:
+    runs-on: [self-hosted, lightweight, Linux, x86_64]
+
+    steps:
+      - uses: actions/checkout at v3
+        with:
+          fetch-depth: 0
+          # ref: ${{ github.event.pull_request.head.sha }}
+          submodules: recursive
+      - name: checkpatch
+        uses: ./.github/actions/checkpatch
+        with:
+          revision-range: HEAD~${{ github.event.pull_request.commits }}..HEAD
-- 
2.34.1



More information about the Tarantool-patches mailing list