You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by er...@apache.org on 2022/12/13 12:12:31 UTC
[commons-math] 01/03: Update release howto.
This is an automated email from the ASF dual-hosted git repository.
erans pushed a commit to annotated tag commons-math-4.0-beta1-RC1
in repository https://gitbox.apache.org/repos/asf/commons-math.git
commit e887e3794e2aa872a128e05062e137a60ad48367
Author: Gilles Sadowski <gi...@gmail.com>
AuthorDate: Tue Dec 13 01:36:55 2022 +0100
Update release howto.
---
doc/release/release.howto.txt | 27 +++++++++++++++++++++------
1 file changed, 21 insertions(+), 6 deletions(-)
diff --git a/doc/release/release.howto.txt b/doc/release/release.howto.txt
index 0096f58ad..196e85ca1 100644
--- a/doc/release/release.howto.txt
+++ b/doc/release/release.howto.txt
@@ -71,9 +71,9 @@ Preliminary checks:
* All Java files must contain a license header. The "RAT" maven plugin will
generate a report indicating for which files the license is missing.
* For a "minor" release, the library must be backward-compatible. Check all
- the errors reported by the "Clirr" plugin.
+ the errors reported by the "Clirr" and/or "Revapi" plugin.
* Clear all "CheckStyle" warnings.
- * Make sure that the construct reported by "FindBugs" are intentional.
+ * Make sure that the construct reported by "SpotBugs" are intentional.
* Mark all fixed issues as such in the bug-tracking system, and add a
corresponding entry in "src/changes/changes.xml".
@@ -86,7 +86,19 @@ that the build process can create all the necessary artifacts. The commands
$ mvn clean site deploy -Prelease -Ptest-deploy
should create the artifacts in the "target/deploy" (note that the "JAVA_HOME"
-environment variable msut be defined to point to a valid JDK installation).
+environment variable must be defined to point to a valid JDK installation).
+
+Note: If running from a remote terminal, you might need to tune the "gpg-agent"
+configuration file
+ ~/.gnupg/gpg-agent.conf
+to contain the following statements:
+ ---CUT---
+ enable-ssh-support
+ pinentry-program /usr/bin/pinentry-tty
+ ---CUT---
+and execute
+ $ export GPG_TTY=$(tty)
+in order to set up the environment for entering the passphrase.
(2)
@@ -100,6 +112,7 @@ remembering the binding between the local and remote origin branches:
$ git branch X.Y-release
$ git push -u origin X.Y-release
+
(3)
Switch to the release branch:
@@ -115,6 +128,8 @@ branch since the creation of the release branch, there are two cases:
merge master branch or version branch into X.Y-release branch:
$ git merge master
+ or
+ $ git rebase master
or, if the version branch is called MATH_3_X
$ git merge MATH_3_X
@@ -134,10 +149,10 @@ In particular:
* Estimate a release date (taking into account the release vote delay) and
insert it in the "src/changes/changes.xml" file.
* Update the "pom.xml" to contain the final version number and not a SNAPSHOT:
- Assuming that the release version will be "3.4", modify the "<version>" tag to
+ Assuming that the release version will be "4.1", modify the "<version>" tag to
read:
- <version>3.4</version>
+ <version>4.1</version>
Modify the section of "<properties>" that also refers to version numbers.
You should uncomment the "<commons.rc.version>" line and indicate the
@@ -147,7 +162,7 @@ In particular:
<properties>
<!-- ... -->
- <commons.release.version>3.4</commons.release.version>
+ <commons.release.version>4.1</commons.release.version>
<commons.rc.version>RC1</commons.rc.version>
<!-- ... -->
</properties>