This is an automated email from the ASF dual-hosted git repository.
aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-rng.git
The following commit(s) were added to refs/heads/master by this push:
new 384dc19d Update release howto
384dc19d is described below
commit 384dc19d591a0e7e1f65f249750beef8a069dcef
Author: aherbert <[email protected]>
AuthorDate: Fri Oct 14 14:30:14 2022 +0100
Update release howto
Copy some additional details from the Numbers release howto.
---
doc/release/release.howto.txt | 57 ++++++++++++++++++++++++++-----------------
1 file changed, 35 insertions(+), 22 deletions(-)
diff --git a/doc/release/release.howto.txt b/doc/release/release.howto.txt
index d3136763..afae5807 100644
--- a/doc/release/release.howto.txt
+++ b/doc/release/release.howto.txt
@@ -75,11 +75,11 @@ NOTE
When performing a release it is good practice to edit a copy of these notes
during the process
and merge the updated document into the repository following a release. To
assist in this process
a find-and-replace can be performed to update all the version numbers in
order. For example
-based on a previous release of 1.5:
+based on a previous release of 1.0:
-- Next development version : 1.6 -> 1.7
-- Next release version : 1.5 -> 1.6
-- Previous release version : 1.4 -> 1.5
+- Next development version : 1.1 -> 1.2
+- Next release version : 1.0 -> 1.1
+- Previous release version : 1.0-beta1 -> 1.0
- Release candidate version : RC1 -> RC2 (if applicable)
This allows the included commands to be coped during the release process.
@@ -403,16 +403,22 @@ documentation. The release profile will not include the
example modules as they
are not part of the binary release artifacts. The 'package' goal is required
to generate a jar file for the japicmp report.
+Using Java 8 ensures a package-list is created for the javadoc in each module.
Later Java
+versions may generate an element-list. If the site is generated including the
examples
+module using JDK 11+ without running 'mvn clean' then the package-list will
coexist
+alongside the newly generated element-list. This allows the javadocs to be
searchable
+from new and old JDKs.
+
This process transfers more files than really needed in the the "staging" (i.e.
non official) maven repository. The files expected in the repository for jar
artifacts are
- commons-rng-<ModuleArtefactID>-1.5.pom
- commons-rng-<ModuleArtefactID>-1.5.jar
- commons-rng-<ModuleArtefactID>-1.5.javadoc.jar
- commons-rng-<ModuleArtefactID>-1.5.sources.jar
- commons-rng-<ModuleArtefactID>-1.5.test-sources.jar
- commons-rng-<ModuleArtefactID>-1.5.tests.jar
- commons-rng-<ModuleArtefactID>-1.5.spdx.rdf.xml
+ commons-rng-<ModuleArtifactID>-1.5.pom
+ commons-rng-<ModuleArtifactID>-1.5.jar
+ commons-rng-<ModuleArtifactID>-1.5.javadoc.jar
+ commons-rng-<ModuleArtifactID>-1.5.sources.jar
+ commons-rng-<ModuleArtifactID>-1.5.test-sources.jar
+ commons-rng-<ModuleArtifactID>-1.5.tests.jar
+ commons-rng-<ModuleArtifactID>-1.5.spdx.rdf.xml
and their associated fingerprints
<file-name>.md5
<file-name>.sha1
@@ -438,10 +444,10 @@ the view and confirm the deletion.
The process used to transfer the complete source and binaries distributions
files,
(for each module):
- commons-rng-<ModuleArtefactId>-1.5-bin.tar.gz
- commons-rng-<ModuleArtefactId>-1.5-bin.zip
- commons-rng-<ModuleArtefactId>-1.5-src.tar.gz
- commons-rng-<ModuleArtefactId>-1.5-src.zip
+ commons-rng-<ModuleArtifactId>-1.5-bin.tar.gz
+ commons-rng-<ModuleArtifactId>-1.5-bin.zip
+ commons-rng-<ModuleArtifactId>-1.5-src.tar.gz
+ commons-rng-<ModuleArtifactId>-1.5-src.zip
as well as their associated .md5 and .sha1 fingerprints and .asc signatures.
All these files are not maven artifacts but rather distribution archives: They
belong elsewhere; hence they must also been removed from the Nexus staging
@@ -515,7 +521,12 @@ Create and upload the other distribution files to the
Apache servers.
of the distribution files. Hence, you have to create them "manually"!
For the signature, the command would be
$ gpg -ab file-to-sign
- For the hash and checksum, see e.g. the "Digest" Perl module.
+ For the hash, the commands is
+ $ sha512sum -b input-file > input-file.sha512
+
+ Double-check the signatures and hashes with the following:
+ $ gpg --verify asc-file
+ $ sha512sum -c hash-file
(12f)
Commit to SVN:
@@ -554,7 +565,8 @@ Then run these commands:
Do not run 'clean' as it will delete the release source/binary artifacts and
the
release plugin cannot be used to generate the template VOTE.txt file with the
- correct hashes.
+ correct hashes. It also removes the previous javadocs package-list generated
using
+ Java 8.
$ mvn -Pcommons-rng-examples package site site:stage
@@ -593,7 +605,6 @@ We have fixed quite a few bugs and added some significant
enhancements since Apa
Apache Commons RNG 1.5 RC1 is available for review here:
https://dist.apache.org/repos/dist/dev/commons/rng/1.5-RC1 (svn revision
49724)
- https://home.apache.org/~aherbert/commons-rng-1.5-RC1-site/
The Git tag commit for this RC is commons-rng-1.5-RC1 which you can browse
here:
https://gitbox.apache.org/repos/asf?p=commons-rng.git;a=commit;h=commons-rng-1.5-RC1
@@ -716,8 +727,8 @@ area of the Apache dist server.
Copy the files from the checkout of the repository that was voted on:
$ svn co https://dist.apache.org/repos/dist/dev/commons/rng rng2
- $ cd rng
- $ rsync -Cav ../rng2/1.5-RC1/ .
+ $ cd rng2
+ $ rsync -Cav ../rng/1.5-RC1/ .
[Note: This might overwrite symbolic links; in this case, do a "svn
revert" in order to restore the files that should not be updated.]
@@ -730,8 +741,8 @@ area of the Apache dist server.
$ svn diff --summarize
- Perform a "svn add" for the new release artefacts.
- Perform a "svn del" for the old release(s) artefacts.
+ Perform a "svn add" for the new release artifacts.
+ Perform a "svn del" for the old release(s) artifacts.
$ svn add binaries/*-1.5-* source/*-1.5-*
$ svn del binaries/*-1.4-* source/*-1.4-*
@@ -1071,6 +1082,8 @@ Update JIRA to close all issues resolved in this release
and prepare for the nex
Add a new version:
- Enter the new version number in the field and click 'Add'.
+ - Versions can be ordered by drag-and-drop. Ensure the latest version is at
the top of the list.
+ (This affects the ordering for the changes jira report.)
Set the release date for the recently release version:
- Click the released version.
