Skip to content

Commit 0c07c82

Browse files
Add CMake instructions to release process
... and make wording a bit more consistent. Co-authored-by: Hennadii Stepanov <[email protected]>
1 parent 3295aa1 commit 0c07c82

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

doc/release-process.md

+11-4
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,20 @@ This process also assumes that there will be no minor releases for old major rel
1515
## Regular release
1616

1717
1. Open a PR to the master branch with a commit (using message `"release: prepare for $MAJOR.$MINOR.$PATCH"`, for example) that
18-
* finalizes the release notes in [CHANGELOG.md](../CHANGELOG.md) (make sure to include an entry for `### ABI Compatibility`) and
19-
* updates `_PKG_VERSION_*`, `_LIB_VERSION_*`, and sets `_PKG_VERSION_IS_RELEASE` to `true` in `configure.ac`.
18+
* finalizes the release notes in [CHANGELOG.md](../CHANGELOG.md) (make sure to include an entry for `### ABI Compatibility`),
19+
* updates `_PKG_VERSION_*` and `_LIB_VERSION_*` and sets `_PKG_VERSION_IS_RELEASE` to `true` in `configure.ac`, and
20+
* updates `project(libsecp256k1 VERSION ...)` and `${PROJECT_NAME}_LIB_VERSION_*` in `CMakeLists.txt`.
2021
2. After the PR is merged, tag the commit and push it:
2122
```
2223
RELEASE_COMMIT=<merge commit of step 1>
2324
git tag -s v$MAJOR.$MINOR.$PATCH -m "libsecp256k1 $MAJOR.$MINOR.$PATCH" $RELEASE_COMMIT
2425
git push [email protected]:bitcoin-core/secp256k1.git v$MAJOR.$MINOR.$PATCH
2526
```
26-
3. Open a PR to the master branch with a commit (using message `"release cleanup: bump version after $MAJOR.$MINOR.$PATCH"`, for example) that sets `_PKG_VERSION_IS_RELEASE` to `false` and `_PKG_VERSION_PATCH` to `$PATCH + 1` and increases `_LIB_VERSION_REVISION`. If other maintainers are not present to approve the PR, it can be merged without ACKs.
27+
3. Open a PR to the master branch with a commit (using message `"release cleanup: bump version after $MAJOR.$MINOR.$PATCH"`, for example) that
28+
* sets `_PKG_VERSION_IS_RELEASE` to `false` and increments `_PKG_VERSION_PATCH` and `_LIB_VERSION_REVISION` in `configure.ac`, and
29+
* increments the `$PATCH` component of `project(libsecp256k1 VERSION ...)` and `${PROJECT_NAME}_LIB_VERSION_REVISION` in `CMakeLists.txt`.
30+
31+
If other maintainers are not present to approve the PR, it can be merged without ACKs.
2732
4. Create a new GitHub release with a link to the corresponding entry in [CHANGELOG.md](../CHANGELOG.md).
2833

2934
## Maintenance release
@@ -38,7 +43,9 @@ Note that bugfixes only need to be backported to releases for which no compatibl
3843
2. Open a pull request to the `$MAJOR.$MINOR` branch that
3944
* includes the bugfixes,
4045
* finalizes the release notes,
41-
* bumps `_PKG_VERSION_PATCH` and `_LIB_VERSION_REVISION` in `configure.ac` (with commit message `"release: update PKG_ and LIB_VERSION for $MAJOR.$MINOR.$PATCH"`, for example).
46+
* increments `_PKG_VERSION_PATCH` and `_LIB_VERSION_REVISION` in `configure.ac`
47+
and the `$PATCH` component of `project(libsecp256k1 VERSION ...)` and `${PROJECT_NAME}_LIB_VERSION_REVISION` in `CMakeLists.txt`
48+
(with commit message `"release: bump versions for $MAJOR.$MINOR.$PATCH"`, for example).
4249
3. After the PRs are merged, update the release branch and tag the commit:
4350
```
4451
git checkout $MAJOR.$MINOR && git pull

0 commit comments

Comments
 (0)