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
commit eb8dec761b1db1ada4bf9ca2bd51734ca5e52346 Author: Alex Herbert <[email protected]> AuthorDate: Tue Apr 21 13:10:46 2026 +0100 Update release notes --- doc/release/release.howto.txt | 317 +++++++++++++++++++----------------------- 1 file changed, 142 insertions(+), 175 deletions(-) diff --git a/doc/release/release.howto.txt b/doc/release/release.howto.txt index 5e1b5cd2..9ca70ad2 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.6: +based on a previous release of 1.7: -- Next development version : 1.7 -> 1.8 -- Next release version : 1.6 -> 1.7 -- Previous release version : 1.5 -> 1.6 +- Next development version : 1.8 -> 1.9 +- Next release version : 1.7 -> 1.8 +- Previous release version : 1.6 -> 1.7 - Release candidate version : RC1 -> RC2 (if applicable) This allows the included commands to be coped during the release process. @@ -95,9 +95,9 @@ Preliminary checks: <properties> <!-- ... --> <!-- upcoming release version --> - <commons.release.version>1.6</commons.release.version> + <commons.release.version>1.7</commons.release.version> <!-- previous release version --> - <commons.bc.version>1.5</commons.bc.version> + <commons.bc.version>1.6</commons.bc.version> <!-- ... --> </properties> Check all the issues reported by the "japicmp" plugin. @@ -126,10 +126,10 @@ that the build process can create all the necessary artifacts. The "dist-archive/target" directory will contain those files: - commons-rng-1.6-SNAPSHOT-bin.tar.gz - commons-rng-1.6-SNAPSHOT-bin.zip - commons-rng-1.6-SNAPSHOT-src.tar.gz - commons-rng-1.6-SNAPSHOT-src.zip + commons-rng-1.7-SNAPSHOT-bin.tar.gz + commons-rng-1.7-SNAPSHOT-bin.zip + commons-rng-1.7-SNAPSHOT-src.tar.gz + commons-rng-1.7-SNAPSHOT-src.zip At some point when processing the above command, the GPG passphrase will be requested; to avoid problems, the "gpg2" executable should be specified in @@ -169,8 +169,8 @@ candidate, create it locally starting from the master branch or the version branch and push it to Apache repository (assuming it is called origin), remembering the binding between the local and remote origin branches: - $ git branch 1.6-release - $ git push -u origin 1.6-release + $ git branch 1.7-release + $ git push -u origin 1.7-release Note that the the release manager name and GPG signing key to be used for the release should be defined in the .m2/settings.xml @@ -180,7 +180,7 @@ should be defined in the .m2/settings.xml (3) Switch to the release branch: - $ git checkout 1.6-release + $ git checkout 1.7-release (4) @@ -188,8 +188,8 @@ If there have been changes committed in the master branch or the version branch since the creation of the release branch, there are two cases: (4a) - if all these changes must be included in version 1.6, merge "master" - or the version branch into "1.6-release": + if all these changes must be included in version 1.7, merge "master" + or the version branch into "1.7-release": $ git merge master @@ -198,15 +198,15 @@ branch since the creation of the release branch, there are two cases: $ git merge RNG_1_X (4b) - if only part of these changes must be included in version 1.6, - cherry-pick the required commits into the "1.6-release" branch: + if only part of these changes must be included in version 1.7, + cherry-pick the required commits into the "1.7-release" branch: $ git cherry-pick commit-SHA (5) Update the release specific files, checking you are really working on the -1.6-release branch and *not* on the master branch. +1.7-release branch and *not* on the master branch. In particular: * Update and commit the "src/site/site.xml" file to contain the information @@ -215,14 +215,14 @@ 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 "1.6", modify the "<version>" tag to + Assuming that the release version will be "1.7", modify the "<version>" tag to read: - <version>1.6</version> + <version>1.7</version> This can be done using maven: - $ mvn versions:set -DnewVersion=1.6 -DgenerateBackupPoms=false + $ mvn versions:set -DnewVersion=1.7 -DgenerateBackupPoms=false Modify the section of "<properties>" that also refers to version numbers. You should uncomment the "<commons.rc.version>" line and indicate the @@ -232,7 +232,7 @@ In particular: <properties> <!-- ... --> - <commons.release.version>1.6</commons.release.version> + <commons.release.version>1.7</commons.release.version> <commons.rc.version>RC1</commons.rc.version> <!-- ... --> </properties> @@ -274,11 +274,11 @@ issue field. Update changes.xml if appropriate. Append the previous release notes from src/site/resources/release-notes/ to the current one: $ (echo "=============================================================================" && - cat src/site/resources/release-notes/RELEASE-NOTES-1.5.txt) >> RELEASE-NOTES.txt + cat src/site/resources/release-notes/RELEASE-NOTES-1.6.txt) >> RELEASE-NOTES.txt Copy the RELEASE-NOTES.txt to src/site/resources/release-notes: - $ cp RELEASE-NOTES.txt src/site/resources/release-notes/RELEASE-NOTES-1.6.txt + $ cp RELEASE-NOTES.txt src/site/resources/release-notes/RELEASE-NOTES-1.7.txt Update the src/site/xdoc/release-history.xml to include the latest version. This generates the release history page on the web site. @@ -314,7 +314,7 @@ Then, assuming the first candidate, the suffix will be "RC1" (this should be the same as in the "<properties>" in the "pom.xml"), and the command will be: - $ git tag -u "__Your_key_id__" -s -m "RC1." commons-rng-1.6-RC1 + $ git tag -u "__Your_key_id__" -s -m "RC1." commons-rng-1.7-RC1 If you have several GPG keys, you may prefer to use "-u keyId" to select a specific key for signing the tag instead of "-s" which select automatically one key @@ -322,13 +322,13 @@ from the configured e-mail address. Check the tag GPG signature: - $ git tag -v commons-rng-1.6-RC1 + $ git tag -v commons-rng-1.7-RC1 You will get something like: object cf4a9d70c9ac24dd7196995390171150e4e56451 type commit - tag commons-rng-1.6-RC1 + tag commons-rng-1.7-RC1 tagger YourName <YourApacheEmail> 1418934614 +0100 RC1. @@ -340,7 +340,7 @@ as it is the most stable reference for traceability. Push everything (including the tag!) on the Apache repository: - $ git push && git push origin commons-rng-1.6-RC1 + $ git push && git push origin commons-rng-1.7-RC1 (9) @@ -348,7 +348,7 @@ Switch to a new directory out of your regular workspace, and retrieve the official tag from the Apache repository: $ cd /tmp - $ git clone https://gitbox.apache.org/repos/asf/commons-rng.git --branch commons-rng-1.6-RC1 + $ git clone https://gitbox.apache.org/repos/asf/commons-rng.git --branch commons-rng-1.7-RC1 In the command above, the --branch option accepts both branch names and tags names, so we specify directly the tag here. Git will warn that the resulting workspace @@ -417,15 +417,17 @@ element-list). To ensure the generated javadoc are searchable for new and old JDKs a package-list will be generated later during the full site build. This process may transfer 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-<ModuleArtifactID>-1.6.pom - commons-rng-<ModuleArtifactID>-1.6.jar - commons-rng-<ModuleArtifactID>-1.6.javadoc.jar - commons-rng-<ModuleArtifactID>-1.6.sources.jar - commons-rng-<ModuleArtifactID>-1.6.test-sources.jar - commons-rng-<ModuleArtifactID>-1.6.tests.jar - commons-rng-<ModuleArtifactID>-1.6.spdx.rdf.xml +non official) maven repository. The files expected in the repository are +(listed in order used by the content browser): + commons-rng-<ModuleArtifactID>-1.7.cyclonedx.json + commons-rng-<ModuleArtifactID>-1.7.cyclonedx.xml + commons-rng-<ModuleArtifactID>-1.7.javadoc.jar + commons-rng-<ModuleArtifactID>-1.7.sources.jar + commons-rng-<ModuleArtifactID>-1.7.test-sources.jar + commons-rng-<ModuleArtifactID>-1.7.tests.jar + commons-rng-<ModuleArtifactID>-1.7.jar + commons-rng-<ModuleArtifactID>-1.7.pom + commons-rng-<ModuleArtifactID>-1.7.spdx.rdf.xml and their associated fingerprints <file-name>.md5 <file-name>.sha1 @@ -434,27 +436,24 @@ and their signatures The commons-rng-parent and commons-rng-bom artifact should contain the pom and the associated fingerprints and signatures. The commons-parent also -contains a Software Package Data Exchange (SPDX) file. +contains a Software Package Data Exchange (SPDX) file and CycloneDX file. The +site.xml file and fingerprints/signature can be deleted. Nexus used to add "md5" and "sha1" checksums files to the "asc" files (cryptographic signature). If these fingerprints on signatures are present, they must be manually removed from Nexus staging area. *** -Note: The commons-rng-bom artifact is deployed using the sign-and-deploy goal -of the maven gpg plugin. This previously added md5 and sha1 files for the artifact -asc files and these should be deleted if present. - Select each .asc.md5 and .asc.sha1 file and delete the artifact. Then refresh the view and confirm the deletion. *** The process used to transfer the complete source and binaries distributions files, (for each module): - commons-rng-<ModuleArtifactId>-1.6-bin.tar.gz - commons-rng-<ModuleArtifactId>-1.6-bin.zip - commons-rng-<ModuleArtifactId>-1.6-src.tar.gz - commons-rng-<ModuleArtifactId>-1.6-src.zip + commons-rng-<ModuleArtifactId>-1.7-bin.tar.gz + commons-rng-<ModuleArtifactId>-1.7-bin.zip + commons-rng-<ModuleArtifactId>-1.7-src.tar.gz + commons-rng-<ModuleArtifactId>-1.7-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 @@ -465,6 +464,8 @@ before other people review the deliverables just created. How to "close" the staging repository is explained at this page: http://www.apache.org/dev/publishing-maven-artifacts.html#close-stage + Close using message: Commons RNG 1.7 RC1 + The nexus staging ID should be noted so that it can be used in the generation of the VOTE email. The id is the XXXX number from the repository id with the format orgapachecommons-XXXX. @@ -474,15 +475,12 @@ format orgapachecommons-XXXX. referred to in this section.] *** -Verify that the release plugin has performed the steps below. -You may be required to remove the staged site from the "dev" area -and add missing files. The following was performed for release 1.6: +Verify that the release plugin has performed the steps below by checking the +staged SVN files. $ cd /tmp $ svn checkout https://dist.apache.org/repos/dist/dev/commons/rng - $ cd rng/1.6-RC1 - $ svn del site - $ svn commit -m "Distribution files for Commons RNG v1.6 (RC1)." + $ cd rng/1.7-RC1 *** Create and upload the other distribution files to the Apache servers. @@ -514,7 +512,7 @@ Create and upload the other distribution files to the Apache servers. Copy other files from the RC workspace: $ cp path-to-the-RC-workspace/RELEASE-NOTES.txt . - $ cp path-to-the-RC-workspace/dist-archive/target/commons-release-plugin/scm/1.6-RC1/README.html . + $ cp path-to-the-RC-workspace/dist-archive/target/commons-release-plugin/scm/1.7-RC1/README.html . $ cp path-to-the-RC-workspace/dist-archive/target/*-bin.* binaries $ cp path-to-the-RC-workspace/dist-archive/target/*-src.* source @@ -540,7 +538,7 @@ Create and upload the other distribution files to the Apache servers. RELEASE-NOTES.txt \ binaries/* \ source/* - $ svn commit -m "Distribution files for Commons RNG v1.6 (RC1)." + $ svn commit -m "Distribution files for Commons RNG v1.7 (RC1)." (13) @@ -557,33 +555,34 @@ Generate the multi-module site for the web site staging area. 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. - + $ mvn -Pexamples package site site:stage - + To ensure the javadocs are searchable from Java 8 requires a package-list. This can be created by copying the element-list. This is only required for the Java 8 modules: - $ find target/staging -name element-list -execdir cp {} package-list \; + $ find target/staging -name element-list -print -execdir cp {} package-list \; $ cd target - $ mv staging commons-rng-1.6-RC1-site + $ mv staging commons-rng-1.7-RC1-site - Checkout the dev staging area. This assumes that the site folder was removed in - validation steps performed in step (12): + Checkout the dev staging area: $ svn checkout https://dist.apache.org/repos/dist/dev/commons/rng --depth immediates - $ cd rng/1.6-RC1 + $ cd rng/1.7-RC1 Update the site folder: - $ cp -pR [path/to/]commons-rng-1.6-RC1-site site + $ svn update site + $ svn del site + $ cp -pR [path/to/]commons-rng-1.7-RC1-site site $ svn add site - $ svn commit -m "Site files for Commons RNG v1.6 (RC1)." + $ svn commit -m "Site files for Commons RNG v1.7 (RC1)." Wait for the files to sync and validate the site at: - https://dist.apache.org/repos/dist/dev/commons/rng/1.6-RC1/site + https://dist.apache.org/repos/dist/dev/commons/rng/1.7-RC1/site (14) @@ -594,9 +593,9 @@ a result that must be heavily edited.] Template the vote using this command (run from the dist-archive module): $ mvn org.apache.commons:commons-release-plugin:vote-txt \ - -Dgit.tag.commit=commons-rng-1.6-RC1 \ + -Prelease \ + -Dgit.tag.commit=commons-rng-1.7-RC1 \ -Dcommons.nexus.repo.id=XXXX - -Prelease where XXXX is the nexus repository staging ID. The output is target/VOTE.txt. This must be heavily edited. It is useful to generate the release hashes. @@ -604,20 +603,20 @@ The release profile assumes this is the profile ID containing the Commons releas manager name and key properties in the settings.xml. Call to vote by sending a message to the "dev" ML with subject -"[VOTE][RC1] Release Commons RNG 1.6". You can use the following example as +"[VOTE][RC1] Release Commons RNG 1.7". You can use the following example as a reference point, replacing the URLs with the appropriate ones: ---------- -We have fixed quite a few bugs and added some significant enhancements since Apache Commons RNG 1.5 was released, so I would like to release Apache Commons RNG 1.6. +We have fixed quite a few bugs and added some significant enhancements since Apache Commons RNG 1.6 was released, so I would like to release Apache Commons RNG 1.7. -Apache Commons RNG 1.6 RC1 is available for review here: - https://dist.apache.org/repos/dist/dev/commons/rng/1.6-RC1 (svn revision 49724) +Apache Commons RNG 1.7 RC1 is available for review here: + https://dist.apache.org/repos/dist/dev/commons/rng/1.7-RC1 (svn revision ????) -The Git tag commit for this RC is commons-rng-1.6-RC1 which you can browse here: - https://gitbox.apache.org/repos/asf?p=commons-rng.git;a=commit;h=commons-rng-1.6-RC1 +The Git tag commit for this RC is commons-rng-1.7-RC1 which you can browse here: + https://gitbox.apache.org/repos/asf?p=commons-rng.git;a=commit;h=commons-rng-1.7-RC1 You may checkout this tag using: - git clone https://gitbox.apache.org/repos/asf/commons-rng.git --branch commons-rng-1.6-RC1 commons-rng-1.6-RC1 -(signature can be checked from git using 'git tag -v commons-rng-1.6-RC1') + git clone https://gitbox.apache.org/repos/asf/commons-rng.git --branch commons-rng-1.7-RC1 commons-rng-1.7-RC1 +(signature can be checked from git using 'git tag -v commons-rng-1.7-RC1') Commit ID the tag points at: 6f2e939bc1ae5d7c1317d4fb1af9ef3ac8d45e54 @@ -629,16 +628,16 @@ These are the artifacts and their hashes: #Release SHA-512s #[Date] -commons-rng-1.6-src.zip=<hash> -commons-rng-1.6-src.tar.gz=<hash> -commons-rng-1.6-bin.tar.gz=<hash> -commons-rng-1.6-bin.zip=<hash> +commons-rng-1.7-src.zip=<hash> +commons-rng-1.7-src.tar.gz=<hash> +commons-rng-1.7-bin.tar.gz=<hash> +commons-rng-1.7-bin.zip=<hash> Signatures may be validated on a system supporting a bash Unix shell by executing: - svn co https://dist.apache.org/repos/dist/dev/commons/rng/1.6-RC1/ - cd 1.6-RC1 + svn co https://dist.apache.org/repos/dist/dev/commons/rng/1.7-RC1/ + cd 1.7-RC1 chmod +x ./signature-validator.sh - for m in client-api core simple sampling bom; do ./signature-validator.sh https://repository.apache.org/content/repositories/orgapachecommons-1596/org/apache/commons/commons-rng-${m}/1.6/; done + for m in client-api core simple sampling bom; do ./signature-validator.sh https://repository.apache.org/content/repositories/orgapachecommons-1596/org/apache/commons/commons-rng-${m}/1.7/; done The source code contains examples that are not part of the public API. These examples contain Java 11 modules and are enabled using a profile (see below). @@ -646,46 +645,38 @@ Note: Testing randomness using statistical thresholds results in failures at a g I have tested this with 'mvn clean install' using: -Apache Maven 3.6.3 (cecedd343002696d0abb50b32b541b8a6ba2883f) -Maven home: /usr/local/apache-maven-3.6.3 -Java version: 1.8.0_241, vendor: Oracle Corporation, runtime: /usr/lib/jvm/jdk1.8.0_241/jre -Default locale: en_GB, platform encoding: UTF-8 -OS name: "linux", version: "4.15.0-153-generic", arch: "amd64", family: "unix" +*** +<mvn -version> +*** I have tested this with 'mvn clean package site site:stage -Pexamples' using: -Apache Maven 3.6.3 (cecedd343002696d0abb50b32b541b8a6ba2883f) -Maven home: /usr/local/apache-maven-3.6.3 -Java version: 11.0.11, vendor: Ubuntu, runtime: /usr/lib/jvm/java-11-openjdk-amd64 -Default locale: en_GB, platform encoding: UTF-8 -OS name: "linux", version: "4.15.0-153-generic", arch: "amd64", family: "unix" +*** +<mvn -version> +*** -Details of changes since 1.5 are in the release notes: - https://dist.apache.org/repos/dist/dev/commons/rng/1.6-RC1/RELEASE-NOTES.txt - https://home.apache.org/~aherbert/commons-rng-1.6-RC1-site/changes-report.html +Details of changes since 1.6 are in the release notes: + https://dist.apache.org/repos/dist/dev/commons/rng/1.7-RC1/RELEASE-NOTES.txt + https://dist.apache.org/repos/dist/dev/commons/rng/1.7-RC1/site/changes.html Site: - https://home.apache.org/~aherbert/commons-rng-1.6-RC1-site/index.html - (note some *relative* links are broken and the 1.6 directories are not yet created - these will be OK once the site is deployed.) - -The site has been staged in a personal Apache space as it includes the examples -modules documentation. These are not staged to the SVN dev staging area during -the release as these are not part of the official release artifacts. + https://dist.apache.org/repos/dist/dev/commons/rng/1.7-RC1/site/ + (note some *relative* links are broken and the 1.7 directories are not yet created - these will be OK once the site is deployed.) -JApiCmp Report (compared to 1.5): - https://home.apache.org/~aherbert/commons-rng-1.6-RC1-site/commons-rng-client-api/japicmp.html - https://home.apache.org/~aherbert/commons-rng-1.6-RC1-site/commons-rng-core/japicmp.html - https://home.apache.org/~aherbert/commons-rng-1.6-RC1-site/commons-rng-simple/japicmp.html - https://home.apache.org/~aherbert/commons-rng-1.6-RC1-site/commons-rng-sampling/japicmp.html +JApiCmp Report (compared to 1.6): + https://dist.apache.org/repos/dist/dev/commons/rng/1.7-RC1/site/commons-rng-client-api/japicmp.html + https://dist.apache.org/repos/dist/dev/commons/rng/1.7-RC1/site/commons-rng-core/japicmp.html + https://dist.apache.org/repos/dist/dev/commons/rng/1.7-RC1/site/commons-rng-simple/japicmp.html + https://dist.apache.org/repos/dist/dev/commons/rng/1.7-RC1/site/commons-rng-sampling/japicmp.html -RevApi Report (compared to 1.5): - https://home.apache.org/~aherbert/commons-rng-1.6-RC1-site/commons-rng-client-api/revapi-report.html - https://home.apache.org/~aherbert/commons-rng-1.6-RC1-site/commons-rng-core/revapi-report.html - https://home.apache.org/~aherbert/commons-rng-1.6-RC1-site/commons-rng-simple/revapi-report.html - https://home.apache.org/~aherbert/commons-rng-1.6-RC1-site/commons-rng-sampling/revapi-report.html +RevApi Report (compared to 1.6): + https://dist.apache.org/repos/dist/dev/commons/rng/1.7-RC1/site/commons-rng-client-api/revapi-report.html + https://dist.apache.org/repos/dist/dev/commons/rng/1.7-RC1/site/commons-rng-core/revapi-report.html + https://dist.apache.org/repos/dist/dev/commons/rng/1.7-RC1/site/commons-rng-simple/revapi-report.html + https://dist.apache.org/repos/dist/dev/commons/rng/1.7-RC1/site/commons-rng-sampling/revapi-report.html RAT Report: - https://home.apache.org/~aherbert/commons-rng-1.6-RC1-site/rat-report.html + https://dist.apache.org/repos/dist/dev/commons/rng/1.7-RC1/site/rat-report.html KEYS: https://downloads.apache.org/commons/KEYS @@ -702,7 +693,6 @@ Thank you, Alex Herbert, Release Manager (using key BC87A3FD0A54480F0BADBEBD21939FF0CA2A6567) - ---------- @@ -734,11 +724,13 @@ area of the Apache dist server. $ find rng -type l (17b) - Copy the files from the checkout of the repository that was voted on: + Copy the files from the checkout of the repository that was voted on + (ignoring the site): $ svn co https://dist.apache.org/repos/dist/dev/commons/rng rng2 + $ rm -rf rng2/1.7-RC1/site $ cd rng - $ rsync -Cav ../rng2/1.6-RC1/ . + $ rsync -Cav ../rng2/1.7-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.] @@ -754,13 +746,13 @@ area of the Apache dist server. Perform a "svn add" for the new release artifacts. Perform a "svn del" for the old release(s) artifacts. - $ svn add binaries/*-1.6-* source/*-1.6-* - $ svn del binaries/*-1.5-* source/*-1.5-* + $ svn add binaries/*-1.7-* source/*-1.7-* + $ svn del binaries/*-1.6-* source/*-1.6-* (17d) Commit: - $ svn commit -m "Release Commons RNG v1.6 (from RC1)." + $ svn commit -m "Release Commons RNG v1.7 (from RC1)." (17e) Register the release at @@ -798,7 +790,7 @@ Remove all files there (except .svn folder) and move all the files from the site $ cd site-content $ rm -rf * - $ cp -pR ../target/commons-rng-1.6-RC1-site/* . + $ cp -pR ../target/commons-rng-1.7-RC1-site/* . Check for new or deleted files: $ svn status @@ -821,7 +813,7 @@ The following commands are useful. Note that the "awk '{if ... print $2}'" only works for files that have no spaces. Currently the only files known to have spaces are the SPDX files, -e.g. 'Apache Commons RNG-1.6.spdx.rdf.xml'; these must be committed manually. +e.g. 'Apache Commons RNG-1.7.spdx.rdf.xml'; these must be committed manually. Reverting (may not be required): @@ -843,7 +835,7 @@ Check the local website: $ open index.html Commit the new contents of the web site: - $ svn commit -m "Commons RNG v1.6 was released (from RC1). Web site update" + $ svn commit -m "Commons RNG v1.7 was released (from RC1). Web site update" Note the SVN website revision for the next step (javadocs archiving). @@ -855,7 +847,7 @@ your component: [edit file: conf/component_releases.properties] - $ (cd conf && svn commit -m "Commons RNG v1.6 was released (from RC1)") + $ (cd conf && svn commit -m "Commons RNG v1.7 was released (from RC1)") (20) @@ -868,7 +860,7 @@ The Javadoc must therefore be copied manually using server side copy from the to work. This is done as follows: $ export RNG_WEB_SITE_SVN_REVISION=1002658 - $ export RNG_RELEASE_VERSION=1.6 + $ export RNG_RELEASE_VERSION=1.7 $ svnmucc -U https://svn.apache.org/repos/infra/websites/production/commons/content/proper/commons-rng \ cp $RNG_WEB_SITE_SVN_REVISION commons-rng-client-api/apidocs \ commons-rng-client-api/javadocs/api-$RNG_RELEASE_VERSION \ @@ -883,7 +875,7 @@ to work. This is done as follows: [Note: The script "doc/release/copyLongTermJavadoc.sh" performs the above command (options are the svn revision and the component's new version).] - $ doc/release/copyLongTermJavadoc.sh -r 1080991 -v 1.6 + $ doc/release/copyLongTermJavadoc.sh -v 1.7 -r 1080991 Wait a few minutes for the live site to fully sync and then check https://commons.apache.org/proper/commons-rng/ @@ -900,7 +892,7 @@ in the SVN repository. [edit file: doap/doap_rng.rdf] - $ (cd doap && svn commit -m "Commons RNG v1.6 was released (from RC1)") + $ (cd doap && svn commit -m "Commons RNG v1.7 was released (from RC1)") Note: A buildbot should automatically rebuild the commons site using the component_releases.properties. @@ -915,12 +907,12 @@ in the SVN repository. > svn diff => check you have not downgraded other components - fix their doap file and repeat > svn commit conf doap -m 'Regenerated component releases' - + > commons-site-build.sh > svn diff target/site > svn commit target/site -m 'Update the staging site prior to deployment' => inspect at https://svn.apache.org/repos/infra/websites/staging/commons/trunk/content/index.html - + > commons-site-publish.sh => inspect target/commons-site-publish.svnmucc => Run svnmucc command printed by the script @@ -930,7 +922,7 @@ in the SVN repository. In the git repository, put the official final tag to point at the same commit as the **last release candidate** tag: - $ git tag -v commons-rng-1.6-RC1 + $ git tag -v commons-rng-1.7-RC1 Check the commit hash then add the release tag. Note: The 'rel/' prefix adds the tag to the release section of the tags. @@ -938,23 +930,23 @@ This cannot be deleted once pushed to the main repository due to restrictions on this section of the tag namespace (preventing deletion of official release tags). - $ git checkout 1.6-release - $ git tag -u "__Your_key_id__" -s -m "RC1 becomes v1.6 official release." rel/commons-rng-1.6 [commit hash] - $ git tag -v rel/commons-rng-1.6 + $ git checkout 1.7-release + $ git tag -u "__Your_key_id__" -s -m "RC1 becomes v1.7 official release." rel/commons-rng-1.7 [commit hash] + $ git tag -v rel/commons-rng-1.7 $ git log -1 - $ git push origin rel/commons-rng-1.6 + $ git push origin rel/commons-rng-1.7 (23) Switch back to the "master" branch. We now prepare for the next round of development (here we assume that the -next version will be 1.7). +next version will be 1.8). (23a) - Retrieve files from the "1.6-release branch" (so that the web site will + Retrieve files from the "1.7-release branch" (so that the web site will contain up-to-date information): - $ git checkout 1.6-release commons-rng-client-api/src/site/site.xml \ + $ git checkout 1.7-release commons-rng-client-api/src/site/site.xml \ commons-rng-core/src/site/site.xml \ commons-rng-simple/src/site/site.xml \ commons-rng-sampling/src/site/site.xml \ @@ -962,7 +954,7 @@ next version will be 1.7). src/changes/changes.xml \ src/site/xdoc/download_rng.xml \ RELEASE-NOTES.txt \ - src/site/resources/release-notes/RELEASE-NOTES-1.6.txt \ + src/site/resources/release-notes/RELEASE-NOTES-1.7.txt \ src/site/xdoc/release-history.xml Check for any other changes to integrate and merge them (this is relevant @@ -970,7 +962,7 @@ next version will be 1.7). would show only version changes in the pom.xml if no other development on master has been performed. - $ git diff 1.6-release + $ git diff 1.7-release Edit "src/changes/changes.xml" to add a new section for the next release, setting the release date and description to "TBD". @@ -979,7 +971,7 @@ next version will be 1.7). (23b) Edit every "pom.xml" file (i.e. for each module) to contain - <version>1.7-SNAPSHOT</version> + <version>1.8-SNAPSHOT</version> This can be done using maven: @@ -993,25 +985,26 @@ next version will be 1.7). Also check the <project.build.outputTimestamp> correctly references rng.build.outputTimestamp (changes will have to be reverted): - $ git grep '1.6-SNAPSHOT' [old version number] - $ git grep '1.7-SNAPSHOT' [new version number] + $ git grep '1.7-SNAPSHOT' [old version number] + $ git grep '1.8-SNAPSHOT' [new version number] $ git grep '<version>' - $ git grep 'project.build.outputTimestamp' + $ git grep 'project.build.outputTimestamp' Then commit them. (23c) Update the README.md files to refer the latest release. These files are - auto-generated from the commons maven plugin using 'mvn commons-build:readme-md'. + auto-generated from the commons maven plugin using + 'mvn commons-build:readme-md -P examples -P integration'. The generated README.md files may have been edited for the multi-module set-up of RNG with extra text added to the main README.md. An updated will involve: - 1. Replacing the <version>1.5</version> example XML for the maven dependency to - <version>1.6</version>. + 1. Replacing the <version>1.6</version> example XML for the maven dependency to + <version>1.7</version>. 2. Updating any badges for Javadocs. This can be done using search and replace - of '1.5.svg' for '1.6.svg' and '/1.5)' for '/1.6)'. + of '1.6.svg' for '1.7.svg' and '/1.6)' for '/1.7)'. Check the changes using 'git diff' and commit. @@ -1050,10 +1043,10 @@ the Apache mailer daemon. You can use the following message as a template: Subject: -[ANNOUNCE] Apache Commons RNG 1.6 released +[ANNOUNCE] Apache Commons RNG 1.7 released ---------- The Apache Commons Team is pleased to announce the availability of -version 1.6 of "Apache Commons RNG". +version 1.7 of "Apache Commons RNG". Apache Commons RNG provides Java implementations of pseudo-random numbers generators. @@ -1063,7 +1056,7 @@ Changes in this version include: ***<Include release notes inline wrapped to 80 characters>*** Historical list of changes: - https://commons.apache.org/proper/commons-rng/changes-report.html + https://commons.apache.org/proper/commons-rng/changes.html For complete information on Apache Commons RNG, including instructions on how to submit bug reports, patches, or suggestions for improvement, see the @@ -1077,23 +1070,6 @@ When downloading, please verify signatures using the KEYS file available at https://downloads.apache.org/commons/KEYS -Maven artifacts are also available in the central Maven repository: - https://repo.maven.apache.org/maven2/org/apache/commons/ - ----- - <groupId>org.apache.commons</groupId> - <artifactId>commons-rng-client-api</artifactId> - <version>1.6</version> ----- - <groupId>org.apache.commons</groupId> - <artifactId>commons-rng-simple</artifactId> - <version>1.6</version> ----- - <groupId>org.apache.commons</groupId> - <artifactId>commons-rng-sampling</artifactId> - <version>1.6</version> ----- - The Apache Commons Team ---------- @@ -1114,7 +1090,7 @@ Update JIRA to close all issues resolved in this release and prepare for the nex Step 1: Select the issues to close. Step 2: Select 'Transition issues'. Step 3: Select to close. - Step 4: Enter comment: 'Closed by release 1.6'. + Step 4: Enter comment: 'Closed by release 1.7'. Unselect 'Send mail for this update'. Confirm. @@ -1136,14 +1112,5 @@ Update JIRA to close all issues resolved in this release and prepare for the nex (26) -If you created a staged version of the website you may wish to delete this -from apache personal area: - - $ lftp sftp://[email protected] - lftp [email protected]:~> cd public_html - lftp [email protected]:~/public_html> rm -rf commons-rng-1.6-RC1-site - lftp [email protected]:~/public_html> bye - -(27) Finally revise the release notes (this document) with any changes to improve the release process.
