doc: Add ABI checking with check-abi.sh to the Release Process

fanquake · Dec 20, 2023 · 74a4d97 · 74a4d97
1 parent e7f830e
commit 74a4d97
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/doc/release-process.md b/doc/release-process.md
@@ -34,6 +34,11 @@ build=$(mktemp -d)
 cmake -B $build -DCMAKE_INSTALL_PREFIX=$dir && cmake --build $build --target install && ls -RlAh $dir
 gcc -o ecdsa examples/ecdsa.c -I $dir/include -L $dir/lib*/ -l secp256k1 -Wl,-rpath,"$dir/lib",-rpath,"$dir/lib64" && ./ecdsa
 ```
+4. Use the [`check-abi.sh`](/tools/check-abi.sh) tool to ensure there are no unexpected ABI incompatibilities and that the version number and release notes accurately reflect all potential ABI changes. To run this tool, the `abi-dumper` and `abi-compliance-checker` packages are required.
+
+```shell
+tools/check-abi.sh
+```
 
 ## Regular release