This is an automated email from the ASF dual-hosted git repository.
robertlazarski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/axis-axis2-java-rampart.git
The following commit(s) were added to refs/heads/master by this push:
new 77a6e2a1 Release documentation updates
77a6e2a1 is described below
commit 77a6e2a1023c1c29cac79476eed85cd7c9d4c5a0
Author: Robert Lazarski
AuthorDate: Tue Dec 10 07:08:47 2024 -1000
Release documentation updates
---
src/site/xdoc/developer-guide.xml | 37 ++---
1 file changed, 22 insertions(+), 15 deletions(-)
diff --git a/src/site/xdoc/developer-guide.xml
b/src/site/xdoc/developer-guide.xml
index c6bcc3fb..ce3a6807 100644
--- a/src/site/xdoc/developer-guide.xml
+++ b/src/site/xdoc/developer-guide.xml
@@ -226,15 +226,29 @@ align="middle" />
In order to prepare the release artifacts for vote, execute the following
steps:
+If not yet done, export your public key and https://dist.apache.org/repos/dist/release/axis/axis2/java/rampart/KEYS";>
append it there.
+
+If not yet done, also export your public key to the dev area and https://dist.apache.org/repos/dist/release/axis/axis2/java/rampart/KEYS";>
append it there.
+
+The command to export a public key is as follows:
+
+gpg --armor --export key_id
+
+If you have multiple keys, you can define a ~/.gnupg/gpg.conf file for a
default. Note that while 'gpg --list-keys' will show your public keys, using
maven-release-plugin with the command 'release:perform' below requires 'gpg
--list-secret-keys' to have a valid entry that matches your public key, in
order to create 'asc' files that are used to verify the release artifcats.
'release:prepare' creates the sha512 checksum files.
+
+The created artifacts i.e. zip files can be checked with, for example,
sha512sum 'rampart-dist-1.8.0-bin.zip' which should match the generated sha512
files. In that example, use 'gpg --verify rampart-dist-1.8.0-bin.zip.asc
rampart-dist-1.8.0-bin.zip' to verify the artifacts were signed correctly
+
If necessary, update the copyright date in the top level NOTICE file.
-Start the release process with the following command - use 'mvn
release:rollback' to undo:
+Start the release process with the following command - use 'mvn
release:rollback' to undo and be aware that in the main pom.xml there is an
apache parent that defines some plugin versions, documented at
https://maven.apache.org/pom/asf/:
+
+Start the release process with the following command - use 'mvn
release:rollback' to undo and be aware that in the main pom.xml there is an
apache parent that defines some plugin versionshttps://maven.apache.org/pom/asf/";> documented here.
mvn release:prepare
When asked for the "SCM release tag or label", keep the default value
(x.y.z)
-The above command will create a tag in Subversion and increment the version
number of the trunk to the next development version. It will also create a
release.properties file that will be used in the next step.
+The above command will create a tag in Git and increment the version number
of the trunk to the next development version. It will also create a
release.properties file that will be used in the next step.
Perform the release using the following command:
@@ -246,17 +260,9 @@ align="middle" />
Execute the target/checkout/etc/dist.py script to upload the source and
binary distributions to the development area of the https://dist.apache.org/repos/dist/";> repository.
-If not yet done, export your public key and https://dist.apache.org/repos/dist/release/axis/axis2/java/rampart/KEYS";>
append it here.
-
-The command to export a public key is as follows:
-
-gpg --armor --export key_id
-
-Create a new staging area for the site:
+https://dist.apache.org/repos/dist/dev/axis/axis2/java/rampart/
-svn copy https://svn.apache.org/repos/asf/axis/site/axis2/java/rampart
https://svn.apache.org/repos/asf/axis/site/axis2/java/rampart-staging
-
-This step can be skipped if the staging area has already been created
earlier (e.g. to test a snapshot version of the site).
+Create a new staging area for the site, clone from
https://github.com/apache/axis-site and commit a copy of the dir
axis2/java/rampart to axis2/java/rampart-staging.
Change to the target/checkout directory and prepare the site using the
following commands:
@@ -264,6 +270,8 @@ align="middle" />
The staging area will be checked out to target/scmpublish-checkout
(relative to target/checkout). Do a sanity check on the changes and then commit
them.
+The root dir of axis-site has a .asf.yaml file, referenced here at
target/scmpublish-checkout/.asf.yaml, that is https://github.com/apache/infrastructure-asfyaml/blob/main/README.md";>
documented here.
+
Start the release vote by sending a mail to java-...@axis.apache.org . The
mail should mention the list of issues solved in the release (by linking to the
relevant JIRA view).
