Skip to content

Commit 7ec246d

Browse files
committed
release process: add sanity checks
1 parent 3353d3c commit 7ec246d

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

doc/release-process.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,26 @@ It is best if the maintainers are present during the release, so they can help e
1212

1313
This process also assumes that there will be no minor releases for old major releases.
1414

15+
## Sanity Checks
16+
Perform these checks before creating a release:
17+
18+
1. Ensure `make distcheck` doesn't fail.
19+
```shell
20+
make distcheck
21+
```
22+
2. Check installation with autotools:
23+
```shell
24+
dir=$(mktemp -d)
25+
./configure --prefix=$dir && make install && ls -l $dir/include $dir/lib
26+
gcc -o ecdsa ecdsa.c -I $dir/include -L $dir/lib64/ -l secp256k1
27+
```
28+
3. Check installation with CMake:
29+
```
30+
dir=$(mktemp -d)
31+
mkdir build && cd build && cmake -DCMAKE_INSTALL_PREFIX=$dir .. && make install && ls -l $dir/include $dir/lib64
32+
gcc -o ecdsa ecdsa.c -I $dir/include -L $dir/lib64/ -l secp256k1
33+
```
34+
1535
## Regular release
1636

1737
1. Open a PR to the master branch with a commit (using message `"release: prepare for $MAJOR.$MINOR.$PATCH"`, for example) that

0 commit comments

Comments
 (0)