What the developer wrote
Authored by Tim Ruffing
release-process: Fix nits
What changed, and why it matters
This commit only makes minor wording edits to the project's release-process documentation. It changes a few phrases from 'PR is merged' to 'PR has been merged', adds 'a' before 'PR', and adds a new step reminding maintainers to merge release notes before announcing a release. There is no code change and no security relevance.
No action needed; this is a documentation-only process nit fix.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff is limited to doc/release-process.md. It consists of grammatical/flow improvements and one procedural addition (step 6: merge the CHANGELOG PR before announcing). No source code, build scripts, cryptographic logic, or configuration is modified.
Changed components
doc/release-process.mdInspect captured patch +4 / −3
diff --git a/doc/release-process.md b/doc/release-process.md
index 40bd220..9bbcd68 100644
--- a/doc/release-process.md
+++ b/doc/release-process.md
@@ -59,7 +59,7 @@ You can see your default key by running `echo "test" | gpg --sign --verbose > /d
* updates `_PKG_VERSION_*` and `_LIB_VERSION_*` in `configure.ac`, and
* updates `project(libsecp256k1 VERSION ...)` and `${PROJECT_NAME}_LIB_VERSION_*` in `CMakeLists.txt`.
2. Perform the [sanity checks](#sanity-checks) on the PR branch.
-3. After the PR is merged, tag the commit, and push the tag:
+3. After the PR has been merged, tag the commit, and push the tag:
```
RELEASE_COMMIT=<merge commit of step 1>
git tag -s v$MAJOR.$MINOR.$PATCH -m "libsecp256k1 $MAJOR.$MINOR.$PATCH" $RELEASE_COMMIT
@@ -88,13 +88,14 @@ Note that bug fixes need to be backported only to releases for which no compatib
and the `$PATCH` component of `project(libsecp256k1 VERSION ...)` and `${PROJECT_NAME}_LIB_VERSION_REVISION` in `CMakeLists.txt`
(with commit message `"release: bump versions for $MAJOR.$MINOR.$PATCH"`, for example).
3. Perform the [sanity checks](#sanity-checks) on the PR branch.
-4. After the PRs are merged, update the release branch, tag the commit, and push the tag:
+4. After the PR has been merged, update the release branch, tag the commit, and push the tag:
```
git checkout $MAJOR.$MINOR && git pull
git tag -s v$MAJOR.$MINOR.$PATCH -m "libsecp256k1 $MAJOR.$MINOR.$PATCH"
git push git@github.com:bitcoin-core/secp256k1.git v$MAJOR.$MINOR.$PATCH
```
-5. 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).
+5. Open a 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).
+6. Get the PR merged to ensure that the [CHANGELOG.md](../CHANGELOG.md) file on the master branch is current before announcing the release.
## Creating a tarball and announcing the release
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.