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-statistics.git
commit fa1d1358fd5322902117ed2a98888ed3c9a07724
Author: Alex Herbert <aherb...@apache.org>
AuthorDate: Wed Sep 17 12:06:55 2025 +0100
Update release documentation
---
doc/release/release.howto.txt | 243 +++++++++++++++++++++---------------------
1 file changed, 123 insertions(+), 120 deletions(-)
diff --git a/doc/release/release.howto.txt b/doc/release/release.howto.txt
index 24849ef..bb41bfa 100644
--- a/doc/release/release.howto.txt
+++ b/doc/release/release.howto.txt
@@ -75,14 +75,14 @@ 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.1:
+based on a previous release of 1.2:
-- Next development version : 1.2 -> 1.3
-- Next release version : 1.1 -> 1.2
-- Previous release version : 1.0 -> 1.1
+- Next development version : 1.3 -> 1.4
+- Next release version : 1.2 -> 1.3
+- Previous release version : 1.1 -> 1.2
- Release candidate version : RC1 -> RC2 (if applicable)
-This allows the included commands to be coped during the release process.
+This allows the included commands to be copied during the release process.
(0)
@@ -95,9 +95,9 @@ Preliminary checks:
<properties>
<!-- ... -->
<!-- upcoming release version -->
- <commons.release.version>1.1</commons.release.version>
+ <commons.release.version>1.2</commons.release.version>
<!-- previous release version -->
- <commons.bc.version>1.0</commons.bc.version>
+ <commons.bc.version>1.1</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-statistics-1.1-SNAPSHOT-bin.tar.gz
- commons-statistics-1.1-SNAPSHOT-bin.zip
- commons-statistics-1.1-SNAPSHOT-src.tar.gz
- commons-statistics-1.1-SNAPSHOT-src.zip
+ commons-statistics-1.2-SNAPSHOT-bin.tar.gz
+ commons-statistics-1.2-SNAPSHOT-bin.zip
+ commons-statistics-1.2-SNAPSHOT-src.tar.gz
+ commons-statistics-1.2-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
@@ -168,8 +168,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.1-release
- $ git push -u origin 1.1-release
+ $ git branch 1.2-release
+ $ git push -u origin 1.2-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
@@ -179,7 +179,7 @@ should be defined in the .m2/settings.xml
(3)
Switch to the release branch:
- $ git checkout 1.1-release
+ $ git checkout 1.2-release
(3a)
if there are any modules not ready for release then remove them from the
@@ -193,18 +193,18 @@ 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.1, merge "master"
- or the version branch into "1.1-release":
+ if all these changes must be included in version 1.2, merge "master"
+ or the version branch into "1.2-release":
$ git merge master
- or, if the version branch is called "1.1-develop"
+ or, if the version branch is called "1.2-develop"
- $ git merge 1.1-develop
+ $ git merge 1.2-develop
(4b)
- if only part of these changes must be included in version 1.1,
- cherry-pick the required commits into the "1.1-release" branch:
+ if only part of these changes must be included in version 1.2,
+ cherry-pick the required commits into the "1.2-release" branch:
$ git cherry-pick commit-SHA
@@ -219,14 +219,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.1", modify the "<version>" tag
to
+ Assuming that the release version will be "1.2", modify the "<version>" tag
to
read:
- <version>1.1</version>
+ <version>1.2</version>
This can be done using maven:
- $ mvn versions:set -DnewVersion=1.1 -DgenerateBackupPoms=false -Pexamples
+ $ mvn versions:set -DnewVersion=1.2 -DgenerateBackupPoms=false -Pexamples
Note: The maven commands may update the project.build.outputTimestamp
property for reproducible builds. A suitable value should be placed into
@@ -242,7 +242,7 @@ In particular:
<properties>
<!-- ... -->
- <commons.release.version>1.1</commons.release.version>
+ <commons.release.version>1.2</commons.release.version>
<commons.rc.version>RC1</commons.rc.version>
<!-- ... -->
</properties>
@@ -278,11 +278,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.0.txt) >>
RELEASE-NOTES.txt
+ cat src/site/resources/release-notes/RELEASE-NOTES-1.1.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.1.txt
+ $ cp RELEASE-NOTES.txt src/site/resources/release-notes/RELEASE-NOTES-1.2.txt
Update the src/site/xdoc/release-history.xml to include the latest version.
This generates
the release history page on the web site.
@@ -316,7 +316,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-statistics-1.1-RC1
+ $ git tag -u "__Your_key_id__" -s -m "RC1" commons-statistics-1.2-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
@@ -324,13 +324,13 @@ from the configured e-mail address.
Check the tag GPG signature:
- $ git tag -v commons-statistics-1.1-RC1
+ $ git tag -v commons-statistics-1.2-RC1
You will get something like:
object cf4a9d70c9ac24dd7196995390171150e4e56451
type commit
- tag commons-statistics-1.1-RC1
+ tag commons-statistics-1.2-RC1
tagger YourName <YourApacheEmail> 1418934614 +0100
RC1
@@ -342,7 +342,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-statistics-1.1-RC1
+ $ git push && git push origin commons-statistics-1.2-RC1
(9)
@@ -350,7 +350,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-statistics.git
--branch commons-statistics-1.1-RC1
+ $ git clone https://gitbox.apache.org/repos/asf/commons-statistics.git
--branch commons-statistics-1.2-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
@@ -397,7 +397,7 @@ You can then generate the release artifacts without the
site generation (using J
$ mvn -Duser.name="__Your_Apache_id__"
[-Dcommons.distServer=apache.releases.https] \
[-Duser.password=<yourApacheIdsPassword] \
- -Prelease clean install site
+ -Prelease clean package site deploy
which will transfer the artifacts to the Nexus repository located at
https://repository.apache.org/index.html#stagingRepositories
@@ -419,13 +419,13 @@ JDKs a package-list will be generated later during the
full site build.
This process transfers more files than really needed in the "staging" (i.e.
non official) maven repository. The files expected in the repository are
- commons-statistics-<ModuleArtifactID>-1.1.pom
- commons-statistics-<ModuleArtifactID>-1.1.jar
- commons-statistics-<ModuleArtifactID>-1.1.javadoc.jar
- commons-statistics-<ModuleArtifactID>-1.1.sources.jar
- commons-statistics-<ModuleArtifactID>-1.1.test-sources.jar
- commons-statistics-<ModuleArtifactID>-1.1.tests.jar
- commons-statistics-<ModuleArtifactID>-1.1.spdx.rdf.xml
+ commons-statistics-<ModuleArtifactID>-1.2.pom
+ commons-statistics-<ModuleArtifactID>-1.2.jar
+ commons-statistics-<ModuleArtifactID>-1.2.javadoc.jar
+ commons-statistics-<ModuleArtifactID>-1.2.sources.jar
+ commons-statistics-<ModuleArtifactID>-1.2.test-sources.jar
+ commons-statistics-<ModuleArtifactID>-1.2.tests.jar
+ commons-statistics-<ModuleArtifactID>-1.2.spdx.rdf.xml
and their associated fingerprints
<file-name>.md5
<file-name>.sha1
@@ -448,15 +448,15 @@ site asc files and these should be deleted.
Select each .asc.md5 and .asc.sha1 file and delete the artifact. Then refresh
the view and confirm the deletion.
-Note: This was not required for release 1.1; the gpg plugin appears to have
been fixed.
+Note: This was not required for release 1.2; the gpg plugin appears to have
been fixed.
***
The process used to transfer the complete source and binaries distributions
files,
(for each module):
- commons-statistics-<ModuleArtifactId>-1.1-bin.tar.gz
- commons-statistics-<ModuleArtifactId>-1.1-bin.zip
- commons-statistics-<ModuleArtifactId>-1.1-src.tar.gz
- commons-statistics-<ModuleArtifactId>-1.1-src.zip
+ commons-statistics-<ModuleArtifactId>-1.2-bin.tar.gz
+ commons-statistics-<ModuleArtifactId>-1.2-bin.zip
+ commons-statistics-<ModuleArtifactId>-1.2-src.tar.gz
+ commons-statistics-<ModuleArtifactId>-1.2-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,7 +465,11 @@ repository.
All jar modules should have the correct entries in the manifest. The manifest
can be read to stdout using e.g.
- $ unzip -p
commons-statistics-distribution/target/commons-statistics-distribution-1.1.jar
META-INF/MANIFEST.MF
+ $ unzip -p
commons-statistics-descriptive/target/commons-statistics-descriptive-1.2.jar
META-INF/MANIFEST.MF
+ $ unzip -p
commons-statistics-distribution/target/commons-statistics-distribution-1.2.jar
META-INF/MANIFEST.MF
+ $ unzip -p
commons-statistics-inference/target/commons-statistics-inference-1.2.jar
META-INF/MANIFEST.MF
+ $ unzip -p
commons-statistics-interval/target/commons-statistics-interval-1.2.jar
META-INF/MANIFEST.MF
+ $ unzip -p
commons-statistics-ranking/target/commons-statistics-ranking-1.2.jar
META-INF/MANIFEST.MF
Entries that must be specific to the module are:
@@ -489,13 +493,13 @@ 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.1:
+and add missing files. The following was performed for release 1.2:
$ cd /tmp
$ svn checkout https://dist.apache.org/repos/dist/dev/commons/statistics
- $ cd statistics/1.1-RC1
+ $ cd statistics/1.2-RC1
$ svn del site
- $ svn commit -m "Distribution files for Commons Statistics v1.1 (RC1)."
+ $ svn commit -m "Distribution files for Commons Statistics v1.2 (RC1)."
***
Create and upload the other distribution files to the Apache servers.
@@ -527,7 +531,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.1-RC1/README.html
.
+ $ cp
path-to-the-RC-workspace/dist-archive/target/commons-release-plugin/scm/1.2-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
@@ -552,7 +556,7 @@ Create and upload the other distribution files to the
Apache servers.
RELEASE-NOTES.txt \
binaries/* \
source/*
- $ svn commit -m "Distribution files for Commons Statistics v1.1 (RC1)."
+ $ svn commit -m "Distribution files for Commons Statistics v1.2 (RC1)."
(13)
@@ -571,7 +575,7 @@ Generate the multi-module site for the web site staging
area.
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:
@@ -579,99 +583,98 @@ Generate the multi-module site for the web site staging
area.
$ find target/staging -name element-list -execdir cp {} package-list \;
$ cd target
- $ mv staging commons-statistics-1.1-RC1-site
+ $ mv staging commons-statistics-1.2-RC1-site
Checkout the dev staging area. This assumes that the site folder was removed
in
validation steps performed in step (12):
$ svn checkout https://dist.apache.org/repos/dist/dev/commons/statistics
--depth immediates
- $ cd statistics/1.1-RC1
-
+ $ cd statistics/1.2-RC1
+
Update the site folder:
-
- $ cp -pR commons-statistics-1.1-RC1-site site
+
+ $ cp -pR [path/to/]commons-statistics-1.2-RC1-site site
$ svn add site
- $ svn commit -m "Site files for Commons Statistics v1.1 (RC1)."
-
+ $ svn commit -m "Site files for Commons Statistics v1.2 (RC1)."
+
Wait for the files to sync and validate the site at:
- https://dist.apache.org/repos/dist/dev/commons/statistics/1.1-RC1/site
+ https://dist.apache.org/repos/dist/dev/commons/statistics/1.2-RC1/site
(14)
[NOTE: The "Commons release-plugin" can generate the text for the "[VOTE]"
message. However, the script makes some (incorrect) assumptions and produces
-a result that must be heavily edited.]
+a result that must be 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-statistics-1.1-RC1 \
+ -Dgit.tag.commit=commons-statistics-1.2-RC1 \
-Prelease \
-Dcommons.nexus.repo.id=XXXX
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.
+This must be edited. It is useful to generate the release hashes.
The release profile is included assuming this is the name of the entry in
the .m2/settings.xml that contains the commons.releaseManagerName/Key entries.
Call to vote by sending a message to the "dev" ML with subject
-"[VOTE] Release Commons Statistics 1.1 based on RC1". You can use the
following example as
+"[VOTE] Release Commons Statistics 1.2 based on RC1". 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 Statistics 1.0 was released,
-so I would like to release Apache Commons Statistics 1.1.
+We have fixed quite a few bugs and added some significant enhancements since
Apache Commons Statistics 1.1 was released,
+so I would like to release Apache Commons Statistics 1.2.
-Apache Commons Statistics 1.1 RC1 is available for review here:
- https://dist.apache.org/repos/dist/dev/commons/statistics/1.1-RC1 (svn
revision 48777)
+Apache Commons Statistics 1.2 RC1 is available for review here:
+ https://dist.apache.org/repos/dist/dev/commons/statistics/1.2-RC1 (svn
revision 48777)
-The Git tag commit for this RC is commons-statistics-1.1-RC1 which you can
browse here:
-
https://gitbox.apache.org/repos/asf?p=commons-statistics.git;a=commit;h=commons-statistics-1.1-RC1
+The Git tag commit for this RC is commons-statistics-1.2-RC1 which you can
browse here:
+
https://gitbox.apache.org/repos/asf?p=commons-statistics.git;a=commit;h=commons-statistics-1.2-RC1
You may checkout this tag using:
- git clone https://gitbox.apache.org/repos/asf/commons-statistics.git
--branch commons-statistics-1.1-RC1 commons-statistics-1.1-RC1
+ git clone https://gitbox.apache.org/repos/asf/commons-statistics.git
--branch commons-statistics-1.2-RC1 commons-statistics-1.2-RC1
Maven artifacts are here:
https://repository.apache.org/content/repositories/orgapachecommons-XXXX/org/apache/commons/
These are the artifacts and their hashes:
-commons-statistics-1.1-bin.tar.gz=<hash>
-commons-statistics-1.1-bin.zip=<hash>
-commons-statistics-1.1-src.tar.gz=<hash>
-commons-statistics-1.1-src.zip=<hash>
+commons-statistics-1.2-bin.tar.gz=<hash>
+commons-statistics-1.2-bin.zip=<hash>
+commons-statistics-1.2-src.tar.gz=<hash>
+commons-statistics-1.2-src.zip=<hash>
(no need for .asc hashes!)
-I have tested this with 'mvn clean install' using:
+I have tested this with 'mvn clean install' and 'mvn clean install site
site:stage -Pexamples' using:
***
<mvn -version>
***
-I have tested this with 'mvn clean install site site:stage -Pexamples' using:
-
-***
-<mvn -version>
-***
-
-Details of changes since 1.0 are in the release notes:
-
https://dist.apache.org/repos/dist/dev/commons/statistics/1.1-RC1/RELEASE-NOTES.txt
+Details of changes since 1.1 are in the release notes:
+
https://dist.apache.org/repos/dist/dev/commons/statistics/1.2-RC1/RELEASE-NOTES.txt
+
https://dist.apache.org/repos/dist/dev/commons/statistics/1.2-RC1/site/changes.html
Site:
-
https://dist.apache.org/repos/dist/dev/commons/statistics/1.1-RC1/site/index.html
- (note some *relative* links are broken and the 1.1 directories are not yet
created - these will be OK once the site is deployed.)
+
https://dist.apache.org/repos/dist/dev/commons/statistics/1.2-RC1/site/index.html
+ (note some *relative* links are broken and the 1.2 directories are not yet
created - these will be OK once the site is deployed.)
JApiCmp Report:
-
https://dist.apache.org/repos/dist/dev/commons/statistics/1.1-RC1/site/commons-statistics-distribution/japicmp.html
+
https://dist.apache.org/repos/dist/dev/commons/statistics/1.2-RC1/site/commons-statistics-descriptive/japicmp.html
+
https://dist.apache.org/repos/dist/dev/commons/statistics/1.2-RC1/site/commons-statistics-distribution/japicmp.html
+
https://dist.apache.org/repos/dist/dev/commons/statistics/1.2-RC1/site/commons-statistics-inference/japicmp.html
+
https://dist.apache.org/repos/dist/dev/commons/statistics/1.2-RC1/site/commons-statistics-interval/japicmp.html
+
https://dist.apache.org/repos/dist/dev/commons/statistics/1.2-RC1/site/commons-statistics-ranking/japicmp.html
RAT Report:
-
https://dist.apache.org/repos/dist/dev/commons/statistics/1.1-RC1/site/rat-report.html
+
https://dist.apache.org/repos/dist/dev/commons/statistics/1.2-RC1/site/rat-report.html
KEYS:
https://downloads.apache.org/commons/KEYS
Please review the release candidate and vote.
-This vote will close no sooner that 72 hours from now.
+This vote will close no sooner than 72 hours from now.
[ ] +1 Release these artifacts
[ ] +0 OK, but...
@@ -716,9 +719,9 @@ 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/statistics
statistics2
- $ rm -rf statistics2/1.1-RC1/site # remove the staged site
+ $ rm -rf statistics2/1.2-RC1/site # remove the staged site
$ cd statistics
- $ rsync -Cav ../statistics2/1.1-RC1/ .
+ $ rsync -Cav ../statistics2/1.2-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.]
@@ -734,13 +737,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 del binaries/*-1.0-* source/*-1.0-*
- $ svn add binaries/*-1.1-* source/*-1.1-*
+ $ svn del binaries/*-1.1-* source/*-1.1-*
+ $ svn add binaries/*-1.2-* source/*-1.2-*
(17d)
Commit:
- $ svn commit -m "Release Commons Statistics v1.1 (from RC1)."
+ $ svn commit -m "Release Commons Statistics v1.2 (from RC1)."
(17e)
Register the release at
@@ -778,7 +781,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-statistics-1.1-RC1-site/* .
+ $ cp -pR ../target/commons-statistics-1.2-RC1-site/* .
Check for new or deleted files:
$ svn status
@@ -822,7 +825,7 @@ Check the local website:
$ open index.html
Commit the new contents of the web site:
- $ svn commit -m "Commons Statistics v1.1 was released (from RC1). Web site
update"
+ $ svn commit -m "Commons Statistics v1.2 was released (from RC1). Web site
update"
Note the SVN website revision for the next step (javadocs archiving).
@@ -834,7 +837,7 @@ your component:
[edit file: component_releases.properties]
- $ (cd conf && svn commit -m "Commons Statistics v1.1 was released (from
RC1)")
+ $ (cd conf && svn commit -m "Commons Statistics v1.2 was released (from
RC1)")
(20)
@@ -847,7 +850,7 @@ The Javadoc must therefore be copied manually using server
side copy from the
to work. This is done using the "doc/release/copyLongTermJavadoc.sh" script
(options are the svn revision and the component's new version).
- $ doc/release/copyLongTermJavadoc.sh -v 1.1 -r 1080991
+ $ doc/release/copyLongTermJavadoc.sh -v 1.2 -r 1080991
Note: New modules will require the 'javadocs' directory to exist on
the server, for example:
@@ -873,7 +876,7 @@ in the SVN repository.
[edit file: doap/doap_statistics.rdf]
- $ (cd doap && svn commit -m "Commons Statistics v1.1 was released (from
RC1)")
+ $ (cd doap && svn commit -m "Commons Statistics v1.2 was released (from
RC1)")
Note: A buildbot should automatically rebuild the commons site using the
component_releases.properties.
@@ -888,12 +891,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
@@ -902,7 +905,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-statistics-1.1-RC1
+ $ git tag -v commons-statistics-1.2-RC1
Check the commit hash then add the release tag.
Note: The 'rel/' prefix adds the tag to the release section of the tags.
@@ -910,26 +913,26 @@ 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.1-release
- $ git tag -u "__Your_key_id__" -s -m "RC1 becomes v1.1 official release."
rel/commons-statistics-1.1 [commit hash]
- $ git tag -v rel/commons-statistics-1.1
+ $ git checkout 1.2-release
+ $ git tag -u "__Your_key_id__" -s -m "RC1 becomes v1.2 official release."
rel/commons-statistics-1.2 [commit hash]
+ $ git tag -v rel/commons-statistics-1.2
$ git log -1
- $ git push origin rel/commons-statistics-1.1
+ $ git push origin rel/commons-statistics-1.2
(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.2).
+next version will be 1.3).
(23a)
- Retrieve changes made on the "1.1-release branch" (so that the web site will
+ Retrieve changes made on the "1.2-release branch" (so that the web site will
contain up-to-date information):
$ git cherry-pick -n [release commit range]
Note: Any unreleased modules may have been deleted; these must be restored:
-
+
$ git restore --staged commons-statistics-regression/LICENSE
$ ...
$ git checkout commons-statistics-regression/LICENSE
@@ -940,7 +943,7 @@ next version will be 1.2).
would show only version changes in the pom.xml if no other development on
master has been performed.
- $ git diff 1.1-release
+ $ git diff 1.2-release
Edit "src/changes/changes.xml" to add a new section for the next release,
setting the release date and description to "TBD".
@@ -948,7 +951,7 @@ next version will be 1.2).
(23b)
Edit every "pom.xml" file (i.e. for each module) to contain
- <version>1.2-SNAPSHOT</version>
+ <version>1.3-SNAPSHOT</version>
This can be done using maven:
@@ -962,8 +965,8 @@ next version will be 1.2).
Also check the <project.build.outputTimestamp> correctly references
statistics.build.outputTimestamp (changes will have to be reverted):
- $ git grep '1.1-SNAPSHOT' [old version number]
- $ git grep '1.2-SNAPSHOT' [new version number]
+ $ git grep '1.2-SNAPSHOT' [old version number]
+ $ git grep '1.3-SNAPSHOT' [new version number]
$ git grep '<version>'
$ git grep 'project.build.outputTimestamp'
@@ -972,18 +975,18 @@ next version will be 1.2).
(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 -Pexamples -Dcommons.release.version=1.1
+
+ $ mvn commons-build:readme-md -Pexamples -Dcommons.release.version=1.2
The generated README.md files may have been edited for the multi-module
set-up with extra text added to the main README.md.
An updated will involve:
- 1. Replacing the <version>1.0</version> example XML for the maven dependency
to
- <version>1.1</version>.
+ 1. Replacing the <version>1.1</version> example XML for the maven dependency
to
+ <version>1.2</version>.
2. Updating any badges for Javadocs. This can be done using search and
replace
- of '1.0.svg' for '1.0.svg' and '/1.0)' for '/1.1)'.
+ of '1.1.svg' for '1.1.svg' and '/1.1)' for '/1.2)'.
Check the changes using 'git diff' and commit.
@@ -1015,10 +1018,10 @@ the Apache mailer daemon.
You can use the following message as a template:
Subject:
-[ANNOUNCE] Apache Commons Statistics Version 1.1 Released
+[ANNOUNCE] Apache Commons Statistics Version 1.2 Released
----------
The Apache Commons Team is pleased to announce the availability of
-version 1.1 of "Apache Commons Statistics".
+version 1.2 of "Apache Commons Statistics".
Apache Commons Statistics provides tools for statistics.
@@ -1061,7 +1064,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.1'.
+ Step 4: Enter comment: 'Closed by release 1.2'.
Unselect 'Send mail for this update'.
Confirm.
