From 627071c9bd9bb5b8ff8a6eb9ac56fd3afd99a068 Mon Sep 17 00:00:00 2001 From: Brian Behlendorf Date: Sun, 6 Dec 2020 09:50:47 -0800 Subject: [PATCH] Enable ABI checks for the checkstyle workflow Extend the CI checkstyle workflow to perform the library ABI checks in the master branch. The intent is not to prevent any ABI changes but to detect them immediately so when they're made it's done intentionally. When the changing the ABI the `make storeabi` target can be used to generate a new .abi file which can be included with the commit. This depends on the libabigail utility which is available from the majority of distribution package managers. Reviewed-by: George Melikov Signed-off-by: Brian Behlendorf Closes #11287 --- .github/PULL_REQUEST_TEMPLATE.md | 1 + .github/workflows/checkstyle.yaml | 6 +++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ef1f595b2d83..465ee182c497 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -28,6 +28,7 @@ https://openzfs.github.io/openzfs-docs/Developer%20Resources/Buildbot%20Options. - [ ] Performance enhancement (non-breaking change which improves efficiency) - [ ] Code cleanup (non-breaking change which makes code smaller or more readable) - [ ] Breaking change (fix or feature that would cause existing functionality to change) +- [ ] Library ABI change (libzfs, libzfs\_core, libnvpair, libuutil and libzfsbootenv) - [ ] Documentation (a change to man pages or other documentation) ### Checklist: diff --git a/.github/workflows/checkstyle.yaml b/.github/workflows/checkstyle.yaml index 06b3a1226b45..1707f5bb21db 100644 --- a/.github/workflows/checkstyle.yaml +++ b/.github/workflows/checkstyle.yaml @@ -18,15 +18,19 @@ jobs: sudo apt-get install --yes -qq zlib1g-dev uuid-dev libattr1-dev libblkid-dev libselinux-dev libudev-dev libssl-dev python-dev python-setuptools python-cffi python3 python3-dev python3-setuptools python3-cffi # packages for tests sudo apt-get install --yes -qq parted lsscsi ksh attr acl nfs-kernel-server fio - sudo apt-get install --yes -qq mandoc cppcheck pax-utils devscripts + sudo apt-get install --yes -qq mandoc cppcheck pax-utils devscripts abigail-tools sudo -E pip --quiet install flake8 - name: Prepare run: | sh ./autogen.sh ./configure + make -j$(nproc) - name: Checkstyle run: | make checkstyle - name: Lint run: | make lint + - name: CheckABI + run: | + make checkabi