Skip to content

Commit 429d21d

Browse files
release process: Run sanity checks on release PR
1 parent efe85c7 commit 429d21d

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

doc/release-process.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This process also assumes that there will be no minor releases for old major rel
1515
We aim to cut a regular release every 3-4 months, approximately twice as frequent as major Bitcoin Core releases. Every second release should be published one month before the feature freeze of the next major Bitcoin Core release, allowing sufficient time to update the library in Core.
1616

1717
## Sanity Checks
18-
Perform these checks before creating a release:
18+
Perform these checks when reviewing the release PR (see below):
1919

2020
1. Ensure `make distcheck` doesn't fail.
2121
```shell
@@ -51,19 +51,20 @@ tools/check-abi.sh
5151
* if this is not a patch release
5252
* updates `_PKG_VERSION_*` and `_LIB_VERSION_*` in `configure.ac` and
5353
* updates `project(libsecp256k1 VERSION ...)` and `${PROJECT_NAME}_LIB_VERSION_*` in `CMakeLists.txt`.
54-
2. After the PR is merged, tag the commit and push it:
54+
2. Perform the [sanity checks](#sanity-checks) on the PR branch.
55+
3. After the PR is merged, tag the commit and push it:
5556
```
5657
RELEASE_COMMIT=<merge commit of step 1>
5758
git tag -s v$MAJOR.$MINOR.$PATCH -m "libsecp256k1 $MAJOR.$MINOR.$PATCH" $RELEASE_COMMIT
5859
git push git@github.com:bitcoin-core/secp256k1.git v$MAJOR.$MINOR.$PATCH
5960
```
60-
3. Open a PR to the master branch with a commit (using message `"release cleanup: bump version after $MAJOR.$MINOR.$PATCH"`, for example) that
61+
4. Open a PR to the master branch with a commit (using message `"release cleanup: bump version after $MAJOR.$MINOR.$PATCH"`, for example) that
6162
* sets `_PKG_VERSION_IS_RELEASE` to `false` and increments `_PKG_VERSION_PATCH` and `_LIB_VERSION_REVISION` in `configure.ac`,
6263
* increments the `$PATCH` component of `project(libsecp256k1 VERSION ...)` and `${PROJECT_NAME}_LIB_VERSION_REVISION` in `CMakeLists.txt`, and
6364
* adds an `[Unreleased]` section header to the [CHANGELOG.md](../CHANGELOG.md).
6465

6566
If other maintainers are not present to approve the PR, it can be merged without ACKs.
66-
4. Create a new GitHub release with a link to the corresponding entry in [CHANGELOG.md](../CHANGELOG.md).
67+
5. Create a new GitHub release with a link to the corresponding entry in [CHANGELOG.md](../CHANGELOG.md).
6768

6869
## Maintenance release
6970

@@ -80,14 +81,15 @@ Note that bugfixes only need to be backported to releases for which no compatibl
8081
* increments `_PKG_VERSION_PATCH` and `_LIB_VERSION_REVISION` in `configure.ac`
8182
and the `$PATCH` component of `project(libsecp256k1 VERSION ...)` and `${PROJECT_NAME}_LIB_VERSION_REVISION` in `CMakeLists.txt`
8283
(with commit message `"release: bump versions for $MAJOR.$MINOR.$PATCH"`, for example).
83-
3. After the PRs are merged, update the release branch and tag the commit:
84+
3. Perform the [sanity checks](#sanity-checks) on the PR branch.
85+
4. After the PRs are merged, update the release branch and tag the commit:
8486
```
8587
git checkout $MAJOR.$MINOR && git pull
8688
git tag -s v$MAJOR.$MINOR.$PATCH -m "libsecp256k1 $MAJOR.$MINOR.$PATCH"
8789
```
88-
4. Push tag:
90+
5. Push tag:
8991
```
9092
git push git@github.com:bitcoin-core/secp256k1.git v$MAJOR.$MINOR.$PATCH
9193
```
92-
5. Create a new GitHub release with a link to the corresponding entry in [CHANGELOG.md](../CHANGELOG.md).
93-
6. Open PR to the master branch that includes a commit (with commit message `"release notes: add $MAJOR.$MINOR.$PATCH"`, for example) that adds release notes to [CHANGELOG.md](../CHANGELOG.md).
94+
6. Create a new GitHub release with a link to the corresponding entry in [CHANGELOG.md](../CHANGELOG.md).
95+
7. Open PR to the master branch that includes a commit (with commit message `"release notes: add $MAJOR.$MINOR.$PATCH"`, for example) that adds release notes to [CHANGELOG.md](../CHANGELOG.md).

0 commit comments

Comments
 (0)