Add CMake instructions to release process

real-or-random commented at 5:10 pm on March 8, 2023: contributor

real-or-random cross-referenced this on Mar 8, 2023 from issue build: Meta-issue for follow-ups to initial CMake merge (#1113) by real-or-random

in doc/release-process.md:20 in 5d0239494d outdated

14@@ -15,8 +15,9 @@ This process also assumes that there will be no minor releases for old major rel
15 ## Regular release
16 
17 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`.
20+   * finalizes the release notes in [CHANGELOG.md](../CHANGELOG.md) (make sure to include an entry for `### ABI Compatibility`),
21+   * updates `_PKG_VERSION_*`, `_LIB_VERSION_*`, and sets `_PKG_VERSION_IS_RELEASE` to `true` in `configure.ac`, and
22+   * updates  `(package secp256k1 VERSION ...` and `LIB_VERSION_*` in `CMakeLists.txt`.

hebasto commented at 5:32 pm on March 8, 2023:

0   * updates  `project(secp256k1 VERSION ...` and `*_LIB_VERSION_*` in `CMakeLists.txt`.

real-or-random force-pushed on Mar 8, 2023

real-or-random renamed this:
~~Add CMake instructions to release procress~~
Add CMake instructions to release process
on Mar 8, 2023

hebasto approved

hebasto commented at 6:10 pm on March 8, 2023: member

ACK b693bdf962006cc14bc88100cbdbd349a1c600fc

jonasnick commented at 6:12 pm on March 8, 2023: contributor

We should also mention in step 3 that the patch version in CMakeLists.txt needs to be increased.

real-or-random force-pushed on Mar 8, 2023

real-or-random commented at 6:42 pm on March 8, 2023: contributor

Hopefully fixed now

in doc/release-process.md:28 in 810e77bc59 outdated

26    git tag -s v$MAJOR.$MINOR.$PATCH -m "libsecp256k1 $MAJOR.$MINOR.$PATCH" $RELEASE_COMMIT
27    git push git@github.com:bitcoin-core/secp256k1.git v$MAJOR.$MINOR.$PATCH
28    ```
29-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.
30+3. Open a PR to the master branch with a commit (using message `"release cleanup: bump version after $MAJOR.$MINOR.$PATCH"`, for example) that
31+   * sets `_PKG_VERSION_IS_RELEASE` to `false` and `_PKG_VERSION_PATCH` to `$PATCH+1` and increments `_LIB_VERSION_REVISION` in `configure.ac`, and

hebasto commented at 6:53 pm on March 8, 2023:

I’m not a native English speaker, but would it be more stylish (?) to replace “sets … _PKG_VERSION_PATCH to $PATCH+1” with something like “increment _PKG_VERSION_PATCH” as it is done for “_LIB_VERSION_REVISION in configure.ac”? (sure, it is not directly related to this PR topic)

real-or-random commented at 7:44 pm on March 8, 2023:

Yes, sounds good.

Let me also take care of the “Maintenance release” section…

hebasto commented at 6:53 pm on March 8, 2023: member

ACK 810e77bc592097272d1ce89b8c8ae3ea3206ff9c

hebasto commented at 6:53 pm on March 8, 2023: member

ACK 810e77bc592097272d1ce89b8c8ae3ea3206ff9c

jonasnick commented at 6:54 pm on March 8, 2023: contributor

ACK 810e77bc592097272d1ce89b8c8ae3ea3206ff9c

real-or-random added this to the milestone 0.3.1 (or 0.4.0) on Mar 8, 2023

real-or-random force-pushed on Mar 8, 2023

real-or-random commented at 11:20 pm on March 8, 2023: contributor

Added respective changes to “Maintenance Release” and also tried to improve the wording / clarity a bit.

real-or-random cross-referenced this on Mar 10, 2023 from issue build: Meta-issue for follow-ups to initial CMake merge (#1113) by hebasto

Add CMake instructions to release process

... and make wording a bit more consistent.

Co-authored-by: Hennadii Stepanov <32963518+hebasto@users.noreply.github.com>

0c07c82834

in doc/release-process.md:47 in 0e3d3aa158 outdated

42@@ -38,7 +43,9 @@ Note that bugfixes only need to be backported to releases for which no compatibl
43 2. Open a pull request to the `$MAJOR.$MINOR` branch that
44    * includes the bugfixes,
45    * finalizes the release notes,
46-   * 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).
47+   * increments `_PKG_VERSION_PATCH` and `_LIB_VERSION_REVISION` in `configure.ac`
48+     and the `$PATCH` component of `project(libsecp256k1 VERSION ...)` and `*_LIB_VERSION_*` in `CMakeLists.txt`

hebasto commented at 11:24 am on March 22, 2023:

0     and the `$PATCH` component of `project(libsecp256k1 VERSION ...)` and `*_LIB_VERSION_REVISION*` in `CMakeLists.txt`

real-or-random commented at 8:41 am on March 26, 2023:

Fixed!

I also changed the leading * to ${PROJECT_NAME}, which is the correct value. The * was just lazy.

real-or-random force-pushed on Mar 26, 2023

hebasto approved

hebasto commented at 9:19 am on March 26, 2023: member

ACK 0c07c828340b66d563499a4795844c8325e089e9

jonasnick approved

jonasnick commented at 3:03 pm on April 7, 2023: contributor

ACK 0c07c828340b66d563499a4795844c8325e089e9

jonasnick merged this on Apr 7, 2023

jonasnick closed this on Apr 7, 2023

sipa referenced this in commit e1552d578e on Apr 11, 2023

sipa referenced this in commit c981671e9b on Apr 14, 2023

hebasto referenced this in commit 49c52ea2b1 on May 13, 2023

RandyMcMillan referenced this in commit 3cc75121b3 on May 27, 2023

vmta referenced this in commit e1120c94a1 on Jun 4, 2023

vmta referenced this in commit 8f03457eed on Jul 1, 2023

jonasnick cross-referenced this on Jul 21, 2023 from issue Upstream PRs 1228, 1236, 1243, 1238, 1246, 1247, 1242, 1250, 1244, 1241, 1257, 1226, 1252, 1118, 1245, 1266, 1269 by jonasnick

Add CMake instructions to release process #1226