Skip to contentSkip to conversation

ci: run more checks in private repositories

PATCH In review David Marchand 3 participants 5 messages Mar 24, 2022 – Nov 26, 2024

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 ci: run more checks in private repositories

Though devtools/checkpatches.sh is run as part of our CI, some other (not well known) checks could help when run in private repositories before submitting to the mailing list and even when run from the ovsrobot.

Most of them require a git history or checked sources to run. And I can't guarantee there won't be false positives.

Add a new job just for those checks so that it won't block compilation tests in other jobs.

---
 .ci/linux-build.sh          |  2 --
 .github/workflows/build.yml | 25 ++++++++++++++++++++++++-
 2 files changed, 24 insertions(+), 3 deletions(-)
.ci/linux-build.sh +0 -2
index 69940dec8b..e3ac497012 100755
@@ -117,8 +117,6 @@ if [ "$ABI_CHECKS" = "true" ]; then
 
     export PATH=$(pwd)/libabigail/bin:$PATH
 
-    REF_GIT_REPO=${REF_GIT_REPO:-https://dpdk.org/git/dpdk}
-
     if [ "$(cat reference/VERSION 2>/dev/null)" != "$REF_GIT_TAG" ]; then
         rm -rf reference
     fi
.github/workflows/build.yml +24 -1
index 02819aa5de..829a10f5be 100644
@@ -9,7 +9,31 @@ defaults:
   run:
     shell: bash --noprofile --norc -exo pipefail {0}
 
+env:
+  REF_GIT_BRANCH: main
+  REF_GIT_REPO: https://dpdk.org/git/dpdk
+  REF_GIT_TAG: v22.03
+
 jobs:
+  checkpatch:
+    if: github.repository != 'DPDK/dpdk'
+    name: Check patches
+    runs-on: ubuntu-18.04
+    steps:
+    - name: Checkout sources
+      uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - name: Check patches
+      run: |
+        git remote add upstream ${{ env.REF_GIT_REPO }}
+        git fetch upstream ${{ env.REF_GIT_BRANCH }}
+        failed=
+        devtools/check-doc-vs-code.sh upstream/${{ env.REF_GIT_BRANCH }} || failed=true
+        devtools/check-git-log.sh -r upstream/${{ env.REF_GIT_BRANCH }}.. || failed=true
+        devtools/check-meson.py || failed=true
+        devtools/check-symbol-maps.sh || failed=true
+        [ -z "$failed" ]
   build:
     name: ${{ join(matrix.config.*, '-') }}
     runs-on: ${{ matrix.config.os }}
@@ -23,7 +47,6 @@ jobs:
       LIBABIGAIL_VERSION: libabigail-1.8
       MINI: ${{ matrix.config.mini != '' }}
       PPC64LE: ${{ matrix.config.cross == 'ppc64le' }}
-      REF_GIT_TAG: v22.03
       RUN_TESTS: ${{ contains(matrix.config.checks, 'tests') }}
 
     strategy:
Signature · 1 line
2.23.0
Acked-by on v1 1/1
#1 lore raw
Quoted 5 lines · David Marchand

Though devtools/checkpatches.sh is run as part of our CI, some other (not well known) checks could help when run in private repositories before submitting to the mailing list and even when run from the ovsrobot.

Quoted 8 lines

Most of them require a git history or checked sources to run. And I can't guarantee there won't be false positives.

Add a new job just for those checks so that it won't block compilation tests in other jobs.

---

Looks good to me. The extra fetches shouldn't take too long (since we refresh main branch weekly to the robot repository). The checks look good - and since it's part of the same build workflow, it will be reported in the same place (and hopefully in a readable form).

#2 lore raw
Quoted 13 lines · Aaron Conole
Quoted 11 lines · David Marchand

Though devtools/checkpatches.sh is run as part of our CI, some other (not well known) checks could help when run in private repositories before submitting to the mailing list and even when run from the ovsrobot.

Most of them require a git history or checked sources to run. And I can't guarantee there won't be false positives.

Add a new job just for those checks so that it won't block compilation tests in other jobs.

Quoted 7 lines
Quoted 2 lines

---

Looks good to me. The extra fetches shouldn't take too long (since we refresh main branch weekly to the robot repository). The checks look good - and since it's part of the same build workflow, it will be reported in the same place (and hopefully in a readable form).

Thanks for the review.

Thomas expressed a concern that the check-git-log.sh script has too many false positives.
I will respin removing this check.

Signature · 1 line
David Marchand
#3 lore raw

PATCH v2 1/1 ci: run more checks in private repositories

In reply to David Marchand

From: David Marchand <[email protected]>

Though devtools/checkpatches.sh is run as part of our CI, some other (not well known) checks could help when run in private repositories before submitting to the mailing list and even when run from the ovsrobot.

Most of them require a git history or checked sources to run. And I can't guarantee there won't be false positives.

Add a new job just for those checks so that it won't block compilation tests in other jobs.

---

Notes:
v2:

* rebased on HEAD
* removed check-git-log.sh from checks to avoid too many false positives

 .ci/linux-build.sh          |  2 --
 .github/workflows/build.yml | 24 +++++++++++++++++++++++-
 2 files changed, 23 insertions(+), 3 deletions(-)
.ci/linux-build.sh +0 -2
index 15ed51e4c18c..fdb578762116 100755
@@ -148,8 +148,6 @@ if [ "$ABI_CHECKS" = "true" ]; then
 
     export PATH=$(pwd)/libabigail/bin:$PATH
 
-    REF_GIT_REPO=${REF_GIT_REPO:-https://dpdk.org/git/dpdk}
-
     if [ "$(cat reference/VERSION 2>/dev/null)" != "$REF_GIT_TAG" ]; then
         rm -rf reference
     fi
.github/workflows/build.yml +23 -1
index dbf25626d4c4..7efc0b935e17 100644
@@ -9,7 +9,30 @@ defaults:
   run:
     shell: bash --noprofile --norc -exo pipefail {0}
 
+env:
+  REF_GIT_BRANCH: main
+  REF_GIT_REPO: https://dpdk.org/git/dpdk
+  REF_GIT_TAG: v24.03
+
 jobs:
+  checkpatch:
+    if: github.repository != 'DPDK/dpdk'
+    name: Check patches
+    runs-on: ubuntu-24.04
+    steps:
+    - name: Checkout sources
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - name: Check patches
+      run: |
+        git remote add upstream ${{ env.REF_GIT_REPO }}
+        git fetch upstream ${{ env.REF_GIT_BRANCH }}
+        failed=
+        devtools/check-doc-vs-code.sh upstream/${{ env.REF_GIT_BRANCH }} || failed=true
+        devtools/check-meson.py || failed=true
+        devtools/check-symbol-maps.sh || failed=true
+        [ -z "$failed" ]
   ubuntu-vm-builds:
     name: ${{ join(matrix.config.*, '-') }}
     runs-on: ${{ matrix.config.os }}
@@ -27,7 +50,6 @@ jobs:
       MINGW: ${{ matrix.config.cross == 'mingw' }}
       MINI: ${{ matrix.config.mini != '' }}
       PPC64LE: ${{ matrix.config.cross == 'ppc64le' }}
-      REF_GIT_TAG: v24.03
       RISCV64: ${{ matrix.config.cross == 'riscv64' }}
       RUN_TESTS: ${{ contains(matrix.config.checks, 'tests') }}
       STDATOMIC: ${{ contains(matrix.config.checks, 'stdatomic') }}
Signature · 1 line
2.45.2
#4 lore raw
Quoted 11 lines · Robin Jarry

From: David Marchand <[email protected]>

Though devtools/checkpatches.sh is run as part of our CI, some other (not well known) checks could help when run in private repositories before submitting to the mailing list and even when run from the ovsrobot.

Most of them require a git history or checked sources to run. And I can't guarantee there won't be false positives.

Quoted 6 lines

Add a new job just for those checks so that it won't block compilation tests in other jobs.

Thanks for respinning, applied.

Signature · 1 line
David Marchand