Skip to content

Commit ad84603

Browse files
committed
release process: clarify change log updates
1 parent 6348bc7 commit ad84603

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

doc/release-process.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,10 @@ gcc -o ecdsa examples/ecdsa.c -I $dir/include -L $dir/lib*/ -l secp256k1 -Wl,-rp
3838
## Regular release
3939

4040
1. Open a PR to the master branch with a commit (using message `"release: prepare for $MAJOR.$MINOR.$PATCH"`, for example) that
41-
* finalizes the release notes in [CHANGELOG.md](../CHANGELOG.md) (make sure to include an entry for `### ABI Compatibility`),
41+
* finalizes the release notes in [CHANGELOG.md](../CHANGELOG.md) by
42+
* adding a section for the release (make sure that the version number is a link to a diff between the previous and new version),
43+
* removing the `[Unreleased]` section header, and
44+
* including an entry for `### ABI Compatibility` if it doesn't exist that mentions the library soname of the release,
4245
* sets `_PKG_VERSION_IS_RELEASE` to `true` in `configure.ac`, and
4346
* if this is not a patch release
4447
* updates `_PKG_VERSION_*` and `_LIB_VERSION_*` in `configure.ac` and
@@ -50,8 +53,9 @@ gcc -o ecdsa examples/ecdsa.c -I $dir/include -L $dir/lib*/ -l secp256k1 -Wl,-rp
5053
git push [email protected]:bitcoin-core/secp256k1.git v$MAJOR.$MINOR.$PATCH
5154
```
5255
3. Open a PR to the master branch with a commit (using message `"release cleanup: bump version after $MAJOR.$MINOR.$PATCH"`, for example) that
53-
* sets `_PKG_VERSION_IS_RELEASE` to `false` and increments `_PKG_VERSION_PATCH` and `_LIB_VERSION_REVISION` in `configure.ac`, and
54-
* increments the `$PATCH` component of `project(libsecp256k1 VERSION ...)` and `${PROJECT_NAME}_LIB_VERSION_REVISION` in `CMakeLists.txt`.
56+
* sets `_PKG_VERSION_IS_RELEASE` to `false` and increments `_PKG_VERSION_PATCH` and `_LIB_VERSION_REVISION` in `configure.ac`,
57+
* increments the `$PATCH` component of `project(libsecp256k1 VERSION ...)` and `${PROJECT_NAME}_LIB_VERSION_REVISION` in `CMakeLists.txt`, and
58+
* adds an `[Unreleased]` section header to the [CHANGELOG.md](../CHANGELOG.md).
5559

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

0 commit comments

Comments
 (0)