Skip to content

Commit 50b0f02

Browse files
Release cleanup and docs, link to JavaDoc via apidocs needs to be fixed still
1 parent 3348434 commit 50b0f02

File tree

8 files changed

+147
-204
lines changed

8 files changed

+147
-204
lines changed

apidocs/pom.xml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,12 @@
5050
<artifactId>rampart-trust</artifactId>
5151
<version>${project.version}</version>
5252
</dependency>
53+
<!-- Artifacts that are needed to generate the Javadoc but that are not transitive dependencies
54+
because they are in scope "provided". -->
55+
<dependency>
56+
<groupId>org.apache.maven.plugin-tools</groupId>
57+
<artifactId>maven-plugin-annotations</artifactId>
58+
</dependency>
5359
</dependencies>
5460
<build>
5561
<plugins>

modules/distribution/bin.xml

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,25 +17,21 @@
1717
<includes>
1818
<include>org.apache.santuario:xmlsec:jar</include>
1919
<include>org.apache.ws.security:wss4j:jar</include>
20-
<include>org.bouncycastle:bcprov-jdk15on:jar</include>
20+
<include>org.bouncycastle:bcprov-jdk18on:jar</include>
2121
<include>org.apache.rampart:rampart-core:jar</include>
2222
<include>org.apache.rampart:rampart-policy:jar</include>
2323
<include>org.apache.rampart:rampart-trust:jar</include>
2424
<include>org.opensaml:opensaml:jar</include>
25-
<include>org.opensaml:xmltooling:jar</include>
25+
<include>org.opensaml:opensaml-soap-impl:jar</include>
26+
<include>org.opensaml:opensaml-soap-api:jar</include>
27+
<include>org.opensaml:opensaml-xacml-impl:jar</include>
28+
<include>org.opensaml:opensaml-xacml-api:jar</include>
2629
<include>org.owasp.esapi:esapi:jar</include>
27-
<include>joda-time:joda-time:jar</include>
2830
<include>org.slf4j:slf4j-api:jar</include>
2931
<include>org.slf4j:slf4j-jcl:jar</include>
3032
<include>velocity:velocity:jar</include>
3133
<include>commons-collections:commons-collections:jar</include>
32-
<include>org.opensaml:openws:jar</include>
3334
<include>commons-lang:commons-lang:jar</include>
34-
<include>org.apache.xerces:xercesImpl:jar</include>
35-
<include>org.apache.xerces:resolver:jar</include>
36-
<include>org.apache.xerces:serializer:jar</include>
37-
<include>org.owasp.esapi:esapi:jar</include>
38-
<include>ca.juliusdavies:not-yet-commons-ssl</include>
3935
</includes>
4036
</dependencySet>
4137
<dependencySet>

pom.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@
163163
<plugin>
164164
<groupId>org.apache.maven.plugins</groupId>
165165
<artifactId>maven-surefire-plugin</artifactId>
166-
<version>3.5.0</version>
166+
<version>3.5.2</version>
167167
</plugin>
168168
<plugin>
169169
<groupId>org.codehaus.mojo</groupId>
@@ -210,7 +210,7 @@
210210
</plugin>
211211
<plugin>
212212
<artifactId>maven-javadoc-plugin</artifactId>
213-
<version>3.10.1</version>
213+
<version>3.11.1</version>
214214
</plugin>
215215
<plugin>
216216
<groupId>com.github.veithen.alta</groupId>
@@ -411,7 +411,7 @@
411411
<plugins>
412412
<plugin>
413413
<artifactId>maven-project-info-reports-plugin</artifactId>
414-
<version>3.7.0</version>
414+
<version>3.8.0</version>
415415
<reportSets>
416416
<reportSet>
417417
<reports>
@@ -639,7 +639,7 @@
639639
<dependency>
640640
<groupId>org.apache.santuario</groupId>
641641
<artifactId>xmlsec</artifactId>
642-
<version>4.0.2</version>
642+
<version>4.0.3</version>
643643
<exclusions>
644644
<exclusion>
645645
<groupId>com.sun.activation</groupId>
@@ -655,17 +655,17 @@
655655
<dependency>
656656
<groupId>org.aspectj</groupId>
657657
<artifactId>aspectjrt</artifactId>
658-
<version>1.9.19</version>
658+
<version>1.9.22.1</version>
659659
</dependency>
660660
<dependency>
661661
<groupId>org.aspectj</groupId>
662662
<artifactId>aspectjweaver</artifactId>
663-
<version>1.9.19</version>
663+
<version>1.9.22.1</version>
664664
</dependency>
665665
<dependency>
666666
<groupId>jakarta.xml.bind</groupId>
667667
<artifactId>jakarta.xml.bind-api</artifactId>
668-
<version>4.0.0</version>
668+
<version>4.0.2</version>
669669
</dependency>
670670

671671
</dependencies>
@@ -731,9 +731,9 @@
731731
<axiom.version>1.4.0</axiom.version>
732732

733733
<wss4j.version>3.0.3</wss4j.version>
734-
<opensaml.version>4.3.0</opensaml.version>
734+
<opensaml.version>4.3.2</opensaml.version>
735735

736-
<bcprov.jdk18.version>1.78.1</bcprov.jdk18.version>
736+
<bcprov.jdk18.version>1.79</bcprov.jdk18.version>
737737

738738
<failIfNoTests>false</failIfNoTests>
739739

src/site/markdown/release-notes/1.8.0.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ namely opensaml to 4.3 and ws-wss4j to 3.0.3.
99

1010
This will be the last javax based release. The next Rampart release will be 2.0.0
1111
and will support Axis2 2.0.0, Jakarta, servlet 6.0 and EE 10. This should happen
12-
soon as the hardwork in Axis2 2.0.0 has been done already.
12+
soon as the hardwork in Axis2 2.0.0 has been done already. The
13+
biggest expected challenge will be the OpenSAML upgrade from
14+
4.x which supports javax, to 5.x which supports jakarta.
1315

1416
The Apache Rampart project and our top level Axis project covering Axis2 needs committers!
1517

src/site/site.xml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@
4646
<item name="Home" href="index.html" />
4747
<item name="Downloads" href="javascript:void(0)">
4848
<item name="Releases" href="download.html"/>
49-
<item name="Source Code" href="svn.html"/>
5049
</item>
5150
<item name="Release Notes" href="javascript:void(0)">
5251
<item name="1.6.1" href="release-notes/1.6.1.html"/>
@@ -64,7 +63,6 @@
6463
<item name="Rampart Configuration" href="rampartconfig-guide.html"/>
6564
<item name="STS Configuration" href="setting-up-sts.html"/>
6665
<item name="Developer Guide" href="developer-guide.html"/>
67-
<item name="Build the Site" href="siteHowTo.html" />
6866
</menu>
6967
<menu name="Resources">
7068
<item name="Articles" href="articles.html" />
@@ -75,7 +73,7 @@
7573
<item name="Project Team" href="team-list.html" />
7674
<item name="Issue Tracking" href="http://issues.apache.org/jira/browse/Rampart" />
7775
<item name="Mailing Lists" href="mail-lists.html"/>
78-
<item name="Source Code" href="http://svn.apache.org/viewvc/axis/axis2/java/rampart/" />
76+
<item name="Source Code" href="https://github.com/apache/axis-axis2-java-rampart" />
7977
<item name="License" href="http://www.apache.org/licenses/"/>
8078
<item name="Sponsorship" href="http://www.apache.org/foundation/sponsorship.html"/>
8179
<item name="Thanks" href="http://www.apache.org/foundation/thanks.html"/>

src/site/xdoc/developer-guide.xml

Lines changed: 123 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,12 @@ Stack</em></strong></p>
2626

2727
<h3>Building Rampart</h3>
2828
<ol>
29-
<li>Install maven2. Refer to the <a
29+
<li>Install maven3. Refer to the <a
3030
href="http://maven.apache.org/guides/getting-started/maven-in-five-minutes.html">Installation
3131
guide</a>.</li>
32-
<li>Install SVN on your machine. (The Rampart repository uses SVN.) Please
33-
read the ASF <a
34-
href="http://www.apache.org/dev/version-control.html">Source Code
35-
Repositories page.</a></li>
3632
<li>Download the source code.
3733
<ul>
38-
<li>Anon Checkout <a
39-
href="https://github.com/apache/axis-axis2-java-rampart">https://github.com/apache/axis-axis2-java-rampart/</a></li>
34+
<li>Checkout <a href="https://github.com/apache/axis-axis2-java-rampart">https://github.com/apache/axis-axis2-java-rampart/</a></li>
4035
</ul>
4136
</li>
4237
<li>The Rampart project has 8 modules under it. They are:
@@ -186,5 +181,125 @@ align="middle" />
186181
<p></p>
187182

188183
<p></p>
189-
</body>
184+
185+
<h3>Release process and release preparation</h3>
186+
<p>Check that all dependencies and plugins are available from standard repositories. To do this, clean the local repository and execute 'mvn clean install followed by 'mvn site'</p>
187+
188+
<p>Check that the set of license files in the legal directory is complete and accurate (by checking that in the binary distribution for every third party JAR in the lib directory. </p>
189+
190+
<p>Check that the apache-release profile can be executed properly. To do this, issue the following command: mvn clean install -Papache-release -DskipTests=true</p>
191+
192+
<p>You may also execute a dry run of the release process: mvn release:prepare -DdryRun=true. After this, you need to clean up using the following command: mvn release:clean</p>
193+
194+
<p>Check that the Maven site can be generated and deployed successfully, and that it has the expected content.</p>
195+
196+
<p>To generate the entire documentation in one place, complete with working inter-module links, execute the site-deploy phase (and check the files under target/staging). A quick and reliable way of doing that is to use the following command: mvn -Dmaven.test.skip=true clean package site-deploy</p>
197+
198+
<p>Complete the release notes in the new src/site/markdown/release-notes .md file, i.e. 2.0.0.md. It should include a description of the major changes in the release as well as a list of resolved JIRA issues.</p>
199+
200+
<h3>Prerequisites</h3>
201+
202+
<p>The following things are required to perform the actual release:</p>
203+
204+
<p>A PGP key that conforms to the <a href="http://specs.xmlsoap.org/ws/2005/02/trust/WS-Trust.pdf"> requirement for Apache release signing</a></p>
205+
206+
<p>To make the release process easier, the passphrase for the code signing key should be configured in ~/.m2/settings.xml</p>
207+
208+
<code><![CDATA[<settings>
209+
...
210+
<profiles>
211+
<profile>
212+
<id>apache-release</id>
213+
<properties>
214+
<gpg.passphrase><!-- KEY PASSPHRASE --></gpg.passphrase>
215+
</properties>
216+
</profile>
217+
</profiles>
218+
...
219+
</settings>]]>
220+
221+
</code>
222+
223+
<p>To make the release process easier, the passphrase for the code signing key should be configured in ~/.m2/settings.xml</p>
224+
225+
<p>The release process uses a Nexus staging repository. Every committer should have access to the corresponding staging profile in Nexus. To validate this, login to repository.apache.org and check that you can see the org.apache.axis staging profile. The credentials used to deploy to Nexus should be added to settings.xml</p>
226+
227+
<h3>Release</h3>
228+
229+
<p>In order to prepare the release artifacts for vote, execute the following steps:</p>
230+
231+
<p>If necessary, update the copyright date in the top level NOTICE file.</p>
232+
233+
<p>Start the release process with the following command:</p>
234+
235+
<code>mvn release:prepare</code>
236+
237+
<p>When asked for the "SCM release tag or label", keep the default value (x.y.z) </p>
238+
239+
<p>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.</p>
240+
241+
<p>Perform the release using the following command: </p>
242+
243+
<code>mvn release:perform</code>
244+
245+
<p>This will upload the release artifacts to the Nexus staging repository.</p>
246+
247+
<p>Close the staging repository. The name of the staging profile is org.apache.axis. See <a href="https://maven.apache.org/developers/release/maven-project-release-procedure.html"> for a more thorough description of this step. </a></p>
248+
249+
<p>Execute the target/checkout/etc/dist.py script to upload the source and binary distributions to the development area of the <a href="https://dist.apache.org/repos/dist/"> repository. </a></p>
250+
251+
<p>If not yet done, export your public key and <a href="https://dist.apache.org/repos/dist/release/axis/axis2/java/rampart/KEYS"> append it here. </a></p>
252+
253+
<p>The command to export a public key is as follows:</p>
254+
255+
<code>gpg --armor --export key_id</code>
256+
257+
<p>Delete <a href="https://dist.apache.org/repos/dist/release/axis/axis2/java/rampart/KEYS"> if it exists. </a></p>
258+
259+
<p>Create a new staging area for the site:</p>
260+
261+
<code>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</code>
262+
263+
<p>This step can be skipped if the staging area has already been created earlier (e.g. to test a snapshot version of the site).</p>
264+
265+
<p>Change to the target/checkout directory and prepare the site using the following commands:</p>
266+
267+
<code>mvn site-deploy ; mvn scm-publish:publish-scm -Dscmpublish.skipCheckin=true</code>
268+
269+
<p>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.</p>
270+
271+
<p>Start the release vote by sending a mail to [email protected] . The mail should mention the list of issues solved in the release (by linking to the relevant JIRA view).</p>
272+
273+
<p>Include a link to the location of the Nexus staging repository, and a link to the <a href="https://dist.apache.org/repos/dist/dev/axis/axis2/java/rampart/"> source and binary distributions. </a></p>
274+
275+
<p>A link to the preview of the <a href="https://axis.apache.org/axis2/java/rampart-staging/"> Maven site. </a></p>
276+
277+
<p>If the vote passes, execute the following steps:</p>
278+
279+
<p>Promote the artifacts in the staging repository. See<a href="https://central.sonatype.org/publish/release/#close-and-drop-or-release-your-staging-repository"> for detailed instructions for this step.</a></p>
280+
281+
<p>Publish the distributions:</p>
282+
283+
<!-- version? -->
284+
<code>svn mv https://dist.apache.org/repos/dist/dev/axis/axis2/java/rampart/ https://dist.apache.org/repos/dist/release/axis/axis2/java/rampart</code>
285+
286+
<p>Publish the site:</p>
287+
288+
<code>svn co --depth=immediates https://svn.apache.org/repos/asf/axis/site/ site ; cd site/axis2/java ; svn rm rampart ; svn mv rampart-staging rampart ; svn commit</code>
289+
290+
<p>It may take several hours before all the updates have been synchronized to the relevant ASF systems. Before proceeding, check that the Maven artifacts for the release are available from the Maven central repository, and the <a href="https://axis.apache.org/axis2/java/rampart/"> Rampart Maven site has been synchronized.</a></p>
291+
292+
<p>Verify the binary and source distributions can be downloaded from the<a href="https://axis.apache.org/axis2/java/rampart/download.html"> Rampart download page.</a></p>
293+
294+
<p>Once everything is in place, send announcements to [email protected] and [email protected]. Since the two lists have different conventions, audiences and moderation policies, to send the announcement separately to the two lists.</p>
295+
296+
<p>Sample announcement:</p>
297+
298+
<p>Apache Rampart Team is pleased to announce the release of Rampart x.y.z. The release is available for download at:</p>
299+
300+
<p>https://axis.apache.org/axis2/java/rampart/download.html</p>
301+
302+
<p>Apache Rampart provides implementations of the WS-Sec* specifications for Apache Axis2, based on Apache WSS4J and the Apache Axiom DOOM implementation.</p>
303+
304+
</body>
190305
</html>

src/site/xdoc/siteHowTo.xml

Lines changed: 0 additions & 60 deletions
This file was deleted.

0 commit comments

Comments
 (0)