Modified: maven/website/content/developers/release/maven-core-release.html ============================================================================== --- maven/website/content/developers/release/maven-core-release.html (original) +++ maven/website/content/developers/release/maven-core-release.html Sat May 11 11:53:23 2024 @@ -2,15 +2,15 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/markdown/developers/release/maven-core-release.md at 2024-05-11 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M18 from content/markdown/developers/release/maven-core-release.md at 2024-05-11 | Rendered using Apache Maven Fluido Skin 2.0.0-M6 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> - <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M10" /> - <title>Maven â Releasing Maven</title> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M18" /> + <title>Maven</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-2.0.0-M6.min.css" /> <link rel="stylesheet" href="../../css/site.css" /> <link rel="stylesheet" href="../../css/print.css" media="print" /> @@ -37,8 +37,10 @@ <div class="container-fluid"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven Site" style="" /></a></div> - <div class="pull-right"><a href="../.././" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><h1>Apache Maven Site</h1> +</a></div> + <div class="pull-right"><a href="../.././" id="bannerRight"><h1>$esc.xml( $banner.name )</h1> +</a></div> <div class="clear"><hr/></div> </div> @@ -46,7 +48,8 @@ <ul class="breadcrumb"> <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class="active ">Releasing Maven <a href="https://github.com/apache/maven-site/tree/master/content/markdown/developers/release/maven-core-release.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + + <li class="active ">Maven <a href="https://github.com/apache/maven-site/tree/master/content/markdown/developers/release/maven-core-release.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-11</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -142,121 +145,7 @@ </div> </header> <main id="bodyColumn" class="span10" > -<section><section> -<h2>Releasing Maven</h2><!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - -<p>Maven differs slightly in its release process due to several extra steps.</p> -<p>The goal is to commit candidate release to svn <code>dev</code> tree <a href="https://dist.apache.org/repos/dist/dev/maven/maven-3"; class="externalLink">https://dist.apache.org/repos/dist/dev/maven/maven-3</a>/<code>$VERSION</code>. Once the vote has passed, svn move to <code>release</code> <a href="https://dist.apache.org/repos/dist/release/maven/maven-3"; class="externalLink">https://dist.apache.org/repos/dist/release/maven/maven-3</a>/<code>$VERSION</code>.</p> -<p>The tree directory is:</p> - -<div class="verbatim"> -<pre><code>https://dist.apache.org/repos/dist/dev/maven/maven-3/ - `-- $VERSION/ - |-- binaries/ - | |-- apache-maven-$VERSION-bin.tar.gz - | |-- apache-maven-$VERSION-bin.tar.gz.asc - | |-- apache-maven-$VERSION-bin.tar.gz.sha512 - | |-- apache-maven-$VERSION-bin.zip - | |-- apache-maven-$VERSION-bin.zip.asc - | `-- apache-maven-$VERSION-bin.zip.sha512 - `-- source/ (notice: singular...) - |-- apache-maven-$VERSION-src.tar.gz - |-- apache-maven-$VERSION-src.tar.gz.asc - |-- apache-maven-$VERSION-src.tar.gz.sha512 - |-- apache-maven-$VERSION-src.zip - |-- apache-maven-$VERSION-src.zip.asc - `-- apache-maven-$VERSION-src.zip.sha512 -</code></pre></div> -<p>Note that the policy for failed releases is to move forward with a new -version. The tag that produced the failed released is left in place for -posterity. So if the release of, say, 3.2.4 fails then we move forward -with 3.2.5.</p><section> -<h3>Produce Release Candidates</h3> -<p>For non-alpha/beta releases, release candidates are produced before the actual release.</p> -<p>Checkout <a href="https://dist.apache.org/repos/dist/dev/maven/maven-3"; class="externalLink">https://dist.apache.org/repos/dist/dev/maven/maven-3</a> then create the necessary directory tree.</p> -<p>Copy the binaries and src-tar.gz with their sha512/asc to the created directories.</p> -<p>To produce a release candidate, follow the first seven steps only from the following procedure:</p> -<ul> - -<li><a href="./maven-project-release-procedure.html">Maven Project Common Release Procedure</a></li> -</ul> -<p>The version used should be the eventual version with -RC1, -RC2, etc. appended.</p> -<p>After producing the RC, request that the developers test the release on the list. If a regression is found, a new release candidate is rolled.</p> -<p>After a reasonable time without regressions found, a wider audience may be polled if the release manager desires (for example, users@).</p> -<p>Once happy with a release candidate, the full release is performed, with the final version in place.</p></section><section> -<h3>Produce the Release</h3> -<p>To produce a final release, the same process as for standard projects is followed:</p> -<ul> - -<li><a href="./maven-project-release-procedure.html">Maven Project Common Release Procedure</a></li> -</ul> -<p>Below describes the additional steps that need to be taken at the points where the website are updated in those instructions.</p><section> -<h4>Prepare the Release Notes</h4> -<p>Checkout Maven site source <a href="https://github.com/apache/maven-site.git"; class="externalLink">https://github.com/apache/maven-site.git</a>.</p> -<p>Create the release notes:</p> -<ul> - -<li>create <code>content/markdown/docs/$version</code></li> -<li>create <code>content/markdown/docs/$version/release-notes.md</code> (see other versions for an example)</li> -</ul></section><section> -<h4>Stage the Latest Documentation</h4> -<p>Once the release is prepared, but before the release vote, the site needs to be staged.</p> -<p>From the release checkout, stage the site:</p> - -<div class="verbatim"> -<pre><code>mvn -Preporting site site:stage -mvn scm-publish:publish-scm -</code></pre></div> -<p>This will publish the Maven core site in <a href="/ref/3-LATEST">/ref/3-LATEST</a>.</p></section></section><section> -<h3>Complete the release</h3> -<p>After a successful vote you should do the following steps to finish the release.</p><section> -<h4>Add New Version to ASF Distribution Directory</h4> -<p>In addition to promoting the repository, the release archives should be -moved to the release svnpubsub tree:</p> - -<div class="verbatim"> -<pre><code>svn mv https://dist.apache.org/repos/dist/dev/maven/maven-3/$VERSION https://dist.apache.org/repos/dist/release/maven/maven-3 -m "Publish Maven $VERSION Distribution Archives" -</code></pre></div></section><section> -<h4>Update the DOAP Information</h4> -<p>Edit <a href="https://github.com/apache/maven/blob/master/doap_Maven.rdf"; class="externalLink">https://github.com/apache/maven/blob/master/doap_Maven.rdf</a> to list the new release.</p></section><section> -<h4>Update the Web Site</h4> -<p>Checkout Maven site source <a href="https://github.com/apache/maven-site.git"; class="externalLink">https://github.com/apache/maven-site.git</a>.</p> -<p>For 3.x: update the <code>versions3x</code>, <code>currentStableVersion</code> and <code>currentStableVersionDetails</code> properties in <code>pom.xml</code></p> -<p>Next, update release history <code>content/markdown/docs/history.md.vm</code>.</p> -<p>Only deploy the site once the release is present on the mirrors, and the reference documentation has been deployed to <a href="/ref">/ref/</a>.</p></section><section> -<h4>Deploy the Latest Documentation to Target Versioned Location</h4> -<p>The reference documentation for Maven core source code references and API docs has been staged in a previous step: now it needs to be deployed to its dedicated directory before deploying the web site pointing to the new version.</p> -<p>This consists in copying in website svn tree the staging /ref/3-LATEST directory to final /ref/<code>$VERSION</code>.</p> - -<div class="verbatim"> -<pre><code>svn cp https://svn.apache.org/repos/asf/maven/website/components/ref/3-LATEST https://svn.apache.org/repos/asf/maven/website/components/ref/$VERSION -m "Maven $VERSION released" -</code></pre></div></section></section><section> -<h3>Information on <code>/ref/current</code> mechanism</h3> -<p>The redirection from <code>/ref/current</code> to actual Maven version reference is done through <code>.htaccess</code> published in site.</p><section> -<h4>Deploying the Release Website</h4> -<p>Once both of the above have synced to the main site and a suitable number of mirrors, proceed to update the web site and produce the announcement.</p> -<p>Commit your changes and then <a href="../website/deploy-maven-website.html">deploy the main Maven site</a>.</p></section><section> -<h4>Remove Old Versions from ASF Distribution Directory</h4> -<p>Next, any superseded releases should be removed from the above locations (after confirming that they exist in /www/archive.apache.org/dist/maven).</p></section><section> -<h4>Proceed with Announcement</h4> -<p>You can now proceed with the steps outlined after deploying the website on <a href="./maven-project-release-procedure.html">Maven Project Common Release Procedure</a></p></section></section></section></section> +<section> </main> </div> </div>
Modified: maven/website/content/developers/release/maven-project-release-procedure.html ============================================================================== --- maven/website/content/developers/release/maven-project-release-procedure.html (original) +++ maven/website/content/developers/release/maven-project-release-procedure.html Sat May 11 11:53:23 2024 @@ -2,18 +2,18 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/apt/developers/release/maven-project-release-procedure.apt at 2024-05-11 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M18 from content/apt/developers/release/maven-project-release-procedure.apt at 2024-05-11 | Rendered using Apache Maven Fluido Skin 2.0.0-M6 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> - <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M10" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M18" /> <meta name="author" content="Jason van Zyl" /> <meta name="author" content="Karl Heinz Marbaise" /> <meta name="date" content="2018-04-07" /> - <title>Maven â Releasing A Maven Project</title> + <title>Maven</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-2.0.0-M6.min.css" /> <link rel="stylesheet" href="../../css/site.css" /> <link rel="stylesheet" href="../../css/print.css" media="print" /> @@ -40,8 +40,10 @@ <div class="container-fluid"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven Site" style="" /></a></div> - <div class="pull-right"><a href="../.././" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><h1>Apache Maven Site</h1> +</a></div> + <div class="pull-right"><a href="../.././" id="bannerRight"><h1>$esc.xml( $banner.name )</h1> +</a></div> <div class="clear"><hr/></div> </div> @@ -49,7 +51,8 @@ <ul class="breadcrumb"> <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class="active ">Releasing A Maven Project <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/release/maven-project-release-procedure.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + + <li class="active ">Maven <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/release/maven-project-release-procedure.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-11</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -145,7 +148,7 @@ </div> </header> <main id="bodyColumn" class="span10" > -<section> +<section><a id="Performing_a_Maven_Project_Release"></a> <h1>Performing a Maven Project Release</h1> <p>This document covers the common release procedures used by the Maven team to perform releases.</p><section> <h2><a id="Prerequisites">Prerequisites</a></h2> @@ -156,22 +159,22 @@ <li>if you receive an OutOfMemoryError during the build, make sure to have set the environment variable <code>MAVEN_OPTS=-Xmx512m</code></li> <li>you must use Maven 3.3.9+.</li> <li>follow Apache environment configuration steps outlined at: <a class="externalLink" href="https://www.apache.org/dev/publishing-maven-artifacts.html#dev-env";>Publishing Maven Artifacts</a>.</li> -<li>check <a href="./pmc-gpg-keys.html"> your Public GPG key</a> which will be used for release.</li></ul></section><section> +<li>check <a href="./pmc-gpg-keys.html"> your Public GPG key</a> which will be used for release.</li></ul></section><section><a id="Before_you_begin"></a> <h2>Before you begin</h2> <p>If you started here, you may first want to review one of the following documents that cover the specifics of various types of releases we have in the Maven Project:</p> <ul> <li><a href="./maven-core-release.html"> Releasing Maven Core</a></li> -<li><a href="./parent-pom-release.html"> Releasing a parent POM</a></li></ul></section><section> +<li><a href="./parent-pom-release.html"> Releasing a parent POM</a></li></ul></section><section><a id="Consider_updating_the_parent_versions"></a> <h2>Consider updating the parent versions</h2> -<p>If the item you are planning to release is not using the most recent version of its parent (see <a href="../../pom/">parent POMs</a> index), consider taking this opportunity to update to it.</p></section><section> +<p>If the item you are planning to release is not using the most recent version of its parent (see <a href="../../pom/">parent POMs</a> index), consider taking this opportunity to update to it.</p></section><section><a id="Consider_updating_the_project_dependencies"></a> <h2>Consider updating the project dependencies</h2> -<p>Generally it is a good that project use tha latest available versions of used dependencies.</p></section><section> +<p>Generally it is a good that project use tha latest available versions of used dependencies.</p></section><section><a id="Prepare_release_notes"></a> <h2>Prepare release notes</h2> <ul> <li>check all commits since latest release, all mentioned issue should be connected with release notes</li> <li>all issues should be <b>assigned</b> to responsible person, which fixed or merged fix</li> <li>all issues should be fixed and <b>CLOSED</b></li> -<li>check existing issues with <b>Blocker</b> priority, consider to fix it or change priority if reasonable</li></ul><section> +<li>check existing issues with <b>Blocker</b> priority, consider to fix it or change priority if reasonable</li></ul><section><a id="Check_release_note_at_GitHub"></a> <h3>Check release note at GitHub</h3> <p>If a component has a history of release notes at <b>GitHub</b>, we should to continue maintain it in order to avoid user confusing.</p> <p>We can maintain release notes at <b>GitHub</b>, by one of:</p> @@ -179,19 +182,17 @@ <li>use release-drafter to help prepare release notes - in such case all PRs should a proper label</li> <li>copy paste release notes from JIRA</li> <li>put link to release notes in JIRA</li></ul> -<p>Draft of release notes at <b>GitHub</b> can be prepared before publishing.</p></section></section><section> +<p>Draft of release notes at <b>GitHub</b> can be prepared before publishing.</p></section></section><section><a id="Make_sure_that_site_compilation_works"></a> <h2>Make sure that site compilation works</h2> <p>Particularly if you update the parent or if you updated your javadoc, the site compilation process may fail, or reveal a conspicuous error. It is stressful and time-consuming to discover this *after* you stage a release and then try to follow the procedure to deploy the site for review. So you may find it more pleasant to check out the state of the site before you start:</p> -<div class="verbatim"> -<pre>mvn -Preporting site site:stage</pre></div></section><section> +<pre>mvn -Preporting site site:stage</pre></section><section><a id="Stage_the_Release"></a> <h2>Stage the Release</h2> -<ol style="list-style-type: decimal"> +<ol style="list-style-type: decimal;"> <li>Follow the release preparation, <b>staging</b> and <b>closing</b> the repository steps outlined in <a class="externalLink" href="https://infra.apache.org/publishing-maven-artifacts.html";>Publishing Maven Releases</a>. <p>Staging repository <code>MUST</code> be closed with message like <code>VOTE Maven component name x.y.z</code></p></li> -<li>Stage the latest documentation as explained in <a href="../website/deploy-component-reference-documentation.html">deploying Maven components reference documentation</a>.</li></ol></section><section> +<li>Stage the latest documentation as explained in <a href="../website/deploy-component-reference-documentation.html">deploying Maven components reference documentation</a>.</li></ol></section><section><a id="Call_the_vote"></a> <h2>Call the vote</h2> <p>Propose a vote on the dev list with the closed issues, the issues left, the staging repository and the staging site. For instance:</p> -<div class="verbatim"> <pre>To: "Maven Developers List" <d...@maven.apache.org> Subject: [VOTE] Release Apache Maven XXX Plugin version Y.Z @@ -221,28 +222,25 @@ Vote open for at least 72 hours. [ ] +1 [ ] +0 [ ] -1 -</pre></div> +</pre> <p>To get the JIRA release notes link, browse to the plugin's or component's JIRA page, select the <i>Releases</i> link, pick a version, and use the link to <i>Release Notes</i> that is next to the version being released.</p> <p>To get the list of issues left in JIRA, browse to the plugin's or component's JIRA page, and from the <i>Preset Filters</i> on the right, use the link for <i>Outstanding</i> issues.</p> <p>The "vote is open for at least 72 hours" means that you need to wait <i>at least</i> 72 hours before proceeding. This gives others time to test your release and check that everything is good. If after that period you have not received enough +1 votes to reach the quorum, this doesn't mean the vote failed: it just takes a bit longer.</p> <p>Checking binary output, ideally to control that the build is reproducible, can be done by running <code>verify</code> (NOT <code>install</code>) followed by <code>artifact:compare</code> against the staged content:</p> -<div class="verbatim"> <pre>mvn -Papache-release -Dgpg.skip clean verify \ - artifact:compare -Dreference.repo=https://repository.apache.org/content/repositories/staging/</pre></div></section><section> + artifact:compare -Dreference.repo=https://repository.apache.org/content/repositories/staging/</pre></section><section><a id="Check_the_vote_results"></a> <h2>Check the vote results</h2> <p>Copied from <a class="externalLink" href="https://www.apache.org/foundation/voting.html#ReleaseVotes";>Votes on Package Releases</a>.</p> -<div class="verbatim"> <pre>Votes on whether a package is ready to be released use majority approval -- i.e. at least three PMC members must vote affirmatively for release, and there must be more positive than negative votes. Releases may not be vetoed. Generally the community will cancel the release vote if anyone identifies serious problems, but in most cases the ultimate decision, lies with the individual serving as release manager. The specifics of the process may vary from project to project, -but the 'minimum quorum of three +1 votes' rule is universal.</pre></div> -<p>The list of PMC members is available at <a class="externalLink" href="https://people.apache.org/committers-by-project.html#maven-pmc";>https://people.apache.org/committers-by-project.html#maven-pmc</a>.</p><section> +but the 'minimum quorum of three +1 votes' rule is universal.</pre> +<p>The list of PMC members is available at <a class="externalLink" href="https://people.apache.org/committers-by-project.html#maven-pmc";>https://people.apache.org/committers-by-project.html#maven-pmc</a>.</p><section><a id="Successful_vote"></a> <h3>Successful vote</h3> <p>Once a vote is <b>successful</b>, post the result to the <code>dev</code> list and cc the <code>PMC</code>. For instance:</p> -<div class="verbatim"> <pre>To: "Maven Developers List" <d...@maven.apache.org> CC: "Maven Project Management Committee List" <priv...@maven.apache.org> Subject: [RESULT] [VOTE] Release Apache Maven XXX Plugin version Y.Z @@ -255,17 +253,16 @@ The vote has passed with the following r PMC quorum: ... -I will promote the source release zip file to Apache distribution area and the artifacts to the central repo.</pre></div> -<p>Follow the procedure to the end.</p></section><section> +I will promote the source release zip file to Apache distribution area and the artifacts to the central repo.</pre> +<p>Follow the procedure to the end.</p></section><section><a id="Unsuccessful_vote"></a> <h3>Unsuccessful vote</h3> <p>Once a vote is <b>unsuccessful</b>, post the result to the <code>dev</code> list, For instance:</p> -<div class="verbatim"> <pre>To: "Maven Developers List" <d...@maven.apache.org> Subject: [CANCEL] [VOTE] Release Apache Maven XXX Plugin version Y.Z Hi, -The vote has been canceled.</pre></div> +The vote has been canceled.</pre> <p>For canceled vote the process will need to be restarted.</p> <p>Be sure to:</p> <ul> @@ -275,25 +272,23 @@ The vote has been canceled.</pre></div> <li>mark the <code>Y.Z</code> version as <b>archived</b></li> <li>report found issues and assign them to version <code>Y.Z+1</code></li> <li>fix found issues</li></ul> -<p>Start the process for version <code>Y.Z+1</code> from the beginning.</p></section></section><section> +<p>Start the process for version <code>Y.Z+1</code> from the beginning.</p></section></section><section><a id="Copy_the_source_release_to_the_Apache_Distribution_Area"></a> <h2>Copy the source release to the Apache Distribution Area</h2> <p>The official Apache release is the 'source-release' bundle distributed in <code>www.apache.org/dist</code>, as described in <a class="externalLink" href="https://www.apache.org/dev/release-distribution";>Apache Release Distribution Policy</a>. All releases for Maven must be copied to <a class="externalLink" href="https://www.apache.org/dist/maven/";>the official Maven release area</a>.</p> <p>The release area is maintained with svnpubsub. To deliver a release, you add it to <a class="externalLink" href="https://dist.apache.org/repos/dist/release/maven";>the subversion repository for the dist area</a>: add the release, its signature and sha512 checksum files, copying them from <code>target/checkout/target/</code> directory created during <code>mvn release:perform</code> step. Currently this requires to be in maven-pmc group (see <a class="externalLink" href="https://issues.apache.org/jira/browse/INFRA-5945";>INFRA-5945</a>). If you are not a PMC member, drop a line to <i>priv...@maven.apache.org</i> and ask them to do this step (and the next one) for you: the PMC member will get the source release bundle and its signature from Nexus staging repository and will create sha512 checksum file by hand, for example using shell:</p> -<div class="verbatim"> -<pre>for f in *.zip ; do echo -n $(sha512sum $f | cut -c -128) > $f.sha512 ; done</pre></div> +<pre>for f in *.zip ; do echo -n $(sha512sum $f | cut -c -128) > $f.sha512 ; done</pre> <p>For example:</p> -<div class="verbatim"> <pre>wagon/wagon-2.2-source-release.zip wagon/wagon-2.2-source-release.zip.asc -wagon/wagon-2.2-source-release.zip.sha512</pre></div> +wagon/wagon-2.2-source-release.zip.sha512</pre> <p>You should also run 'svn rm' as needed to clear out older releases. As per <a class="externalLink" href="https://www.apache.org/legal/release-policy.html#where-do-releases-go";>Apache Release Policy</a>, only the latest release on a branch should stay in the main dist areas. So long as the previous release is at least a day old, the automatic archiver will have copied it to the archive.</p> -<p>To check that everything is ok in the dist area, dist-tool-plugin has been written and run once a day to produce <a class="externalLink" href="https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-dist-tool/job/master/site/";>"Check Source Release" and "Check Errors" reports</a>.</p></section><section> +<p>To check that everything is ok in the dist area, dist-tool-plugin has been written and run once a day to produce <a class="externalLink" href="https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-dist-tool/job/master/site/";>"Check Source Release" and "Check Errors" reports</a>.</p></section><section><a id="Add_the_release_for_next_board_report"></a> <h2>Add the release for next board report</h2> <p>After committing the 3 source-release files, visit <a class="externalLink" href="https://reporter.apache.org/addrelease.html?maven";>Apache Committee Report Helper</a> to add your release data with the Full Version Name and Date of Release. (You will receive an e-mail for it as well).</p> -<p>If you are not a PMC member, drop a line to <i>priv...@maven.apache.org</i> and ask them to do this step for you if they did not do the update while adding to release area.</p></section><section> +<p>If you are not a PMC member, drop a line to <i>priv...@maven.apache.org</i> and ask them to do this step for you if they did not do the update while adding to release area.</p></section><section><a id="Promote_the_release"></a> <h2>Promote the release</h2> <p>Once the release is deemed fit for public consumption it can be transferred to a production repository where it will be available to all users.</p> -<ol style="list-style-type: decimal"> +<ol style="list-style-type: decimal;"> <li>See <a class="externalLink" href="https://www.apache.org/dev/publishing-maven-artifacts.html#promote";>Promoting a Repo</a> for details on promotion.</li> <li>Deploy the current website <p>As above, deploy the web site if appropriate and update the project site for the new release: use <a href="../website/component-reference-documentation-helper.html">Component Reference Documentation Helper</a> to generate commands or see <a href="../website/deploy-component-reference-documentation.html#Publishing_versioned_component_reference_documentation">Publishing versioned component reference documentation</a> for explanations. Note that not all projects follow these conventions exactly.</p> @@ -302,7 +297,7 @@ wagon/wagon-2.2-source-release.zip.sha51 <p>In the relevant project, go to Administration, then Versions. Mark the <code>Y.Z</code> version as 'released'. Create version <code>Y.Z+1</code>, if that hasn't already been done. You may also archive any deprecated releases (milestones or alphas) at this time.</p> <p>Note: Currently this requires to be in the maven-pmc group. So, if you don't see the Administration option in JIRA, kindly ask <i>priv...@maven.apache.org</i> to do this step for you.</p></li> <li>Wait for everything to sync -<ol style="list-style-type: lower-alpha"> +<ol style="list-style-type: lower-alpha;"> <li>Sync to <a class="externalLink" href="https://repo.maven.apache.org/maven2/org/apache/maven/";>Maven Central</a> <p>The sync into central staging from repository.apache.org occurs every 4 hours. There is a separate hourly schedule that runs which pushes from staging to the other central machines, and then updates the indexes.</p></li> <li>Sync to Maven Website @@ -310,7 +305,6 @@ wagon/wagon-2.2-source-release.zip.sha51 <li>Create an announcement. <p>Following instructions are done for plugins: if you are releasing anything else than a plugin, you should adapt email content to match what you are releasing.</p> <p><b>Note:</b> You must send this email from your apache email account, e.g. your_apache_usern...@apache.org otherwise the email to <code>annou...@maven.apache.org</code> will bounce.</p> -<div class="verbatim"> <pre>From: your_apache_usern...@apache.org To: annou...@maven.apache.org, us...@maven.apache.org Cc: d...@maven.apache.org @@ -341,11 +335,11 @@ Release Notes - Maven XXX Plugin - Versi Enjoy, -The Apache Maven team -</pre></div></li> +</pre></li> <li>If releasing the Apache Parent POM, notify <code>release-disc...@apache.org</code>: Several projects follow this list, and should be made aware of changes to the common parent. This might also be a step to take if other shared resources are released, or if plugin releases are of particular interest to that group. <p>If releasing Maven Core, notify <code>annou...@apache.org</code></p></li> <li>Publish release notes at <b>GitHub</b> if it is maintained.</li> -<li>Celebrate :o)</li></ol></section><section> +<li>Celebrate :o)</li></ol></section><section><a id="Check_Consistency"></a> <h2>Check Consistency</h2> <p>You can also check if you (or any previous release manager) did not miss any step by looking at the <a class="externalLink" href="https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-dist-tool/job/master/site/dist-tool-check-errors.html";> Dist Tool Check Errors report</a>.</p></section></section> </main> Modified: maven/website/content/developers/release/parent-pom-release.html ============================================================================== --- maven/website/content/developers/release/parent-pom-release.html (original) +++ maven/website/content/developers/release/parent-pom-release.html Sat May 11 11:53:23 2024 @@ -2,18 +2,18 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/apt/developers/release/parent-pom-release.apt at 2024-05-11 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M18 from content/apt/developers/release/parent-pom-release.apt at 2024-05-11 | Rendered using Apache Maven Fluido Skin 2.0.0-M6 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> - <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M10" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M18" /> <meta name="author" content="Hervé Boutemy" /> <meta name="author" content="Dennis Lundberg" /> <meta name="date" content="2013-12-07" /> - <title>Maven â Releasing A Parent POM</title> + <title>Maven</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-2.0.0-M6.min.css" /> <link rel="stylesheet" href="../../css/site.css" /> <link rel="stylesheet" href="../../css/print.css" media="print" /> @@ -40,8 +40,10 @@ <div class="container-fluid"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven Site" style="" /></a></div> - <div class="pull-right"><a href="../.././" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><h1>Apache Maven Site</h1> +</a></div> + <div class="pull-right"><a href="../.././" id="bannerRight"><h1>$esc.xml( $banner.name )</h1> +</a></div> <div class="clear"><hr/></div> </div> @@ -49,7 +51,8 @@ <ul class="breadcrumb"> <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class="active ">Releasing A Parent POM <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/release/parent-pom-release.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + + <li class="active ">Maven <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/release/parent-pom-release.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-11</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -145,29 +148,26 @@ </div> </header> <main id="bodyColumn" class="span10" > -<section> +<section><a id="Releasing_A_Parent_POM"></a> <h1>Releasing A Parent POM</h1> <p>Releasing a Parent POM is much the same as any other Maven project. The following guide walks through most of the steps:</p> <ul> <li><a href="./maven-project-release-procedure.html"> Maven Project Common Release procedure</a></li></ul> -<p>Note that Parent POMs have particular conventions for managing and deploying the documentation.</p><section> +<p>Note that Parent POMs have particular conventions for managing and deploying the documentation.</p><section><a id="Rationale"></a> <h2>Rationale</h2> -<p>To be able to publish a documentation for the parent POM without affecting released <code>pom.xml</code> and <code>site.xml</code>, parent POM projects have a specific module, with the documentations <code>docs</code>.</p></section><section> +<p>To be able to publish a documentation for the parent POM without affecting released <code>pom.xml</code> and <code>site.xml</code>, parent POM projects have a specific module, with the documentations <code>docs</code>.</p></section><section><a id="Stage_the_release"></a> <h2>Stage the release</h2> <p>Then the only difference is with commands to stage the site:</p> <p>In Maven Apache Parent POM:</p> -<div class="verbatim"> <pre>cd target/checkout mvn -f docs site -mvn -f docs scm-publish:publish-scm</pre></div> +mvn -f docs scm-publish:publish-scm</pre> <p>In Maven Projects Parent POM:</p> -<div class="verbatim"> <pre>cd target/checkout mvn -f docs site site:stage -mvn -f docs scm-publish:publish-scm</pre></div></section><section> +mvn -f docs scm-publish:publish-scm</pre></section><section><a id="Call_the_vote"></a> <h2>Call the vote</h2> <p>In the vote, additional to providing links to JIRA, the parent POMs should include a link to the Git changes since the last release:</p> -<div class="verbatim"> <pre>... Hi, @@ -179,7 +179,7 @@ or for Maven Projects Parent POM: https://github.com/apache/maven-parent/compare/maven-parent-<VERSION-OF-PREVIOUS-RELEASE>...maven-parent-<VERSION-OF-CURRENT-RELEASE> Staging repo: -...</pre></div></section></section> +...</pre></section></section> </main> </div> </div> Modified: maven/website/content/developers/release/pmc-gpg-keys.html ============================================================================== --- maven/website/content/developers/release/pmc-gpg-keys.html (original) +++ maven/website/content/developers/release/pmc-gpg-keys.html Sat May 11 11:53:23 2024 @@ -2,17 +2,17 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/apt/developers/release/pmc-gpg-keys.apt at 2024-05-11 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M18 from content/apt/developers/release/pmc-gpg-keys.apt at 2024-05-11 | Rendered using Apache Maven Fluido Skin 2.0.0-M6 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> - <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M10" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M18" /> <meta name="author" content="Vincent Siveton" /> <meta name="date" content="2006-10-01" /> - <title>Maven â Developers centre - Making GPG Keys</title> + <title>Maven</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-2.0.0-M6.min.css" /> <link rel="stylesheet" href="../../css/site.css" /> <link rel="stylesheet" href="../../css/print.css" media="print" /> @@ -39,8 +39,10 @@ <div class="container-fluid"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven Site" style="" /></a></div> - <div class="pull-right"><a href="../.././" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><h1>Apache Maven Site</h1> +</a></div> + <div class="pull-right"><a href="../.././" id="bannerRight"><h1>$esc.xml( $banner.name )</h1> +</a></div> <div class="clear"><hr/></div> </div> @@ -48,7 +50,8 @@ <ul class="breadcrumb"> <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class="active ">Developers centre - Making GPG Keys <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/release/pmc-gpg-keys.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + + <li class="active ">Maven <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/release/pmc-gpg-keys.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-11</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -144,27 +147,27 @@ </div> </header> <main id="bodyColumn" class="span10" > -<section> +<section><a id="Introduction"></a> <h1>Introduction</h1> <p><b>Before</b> a release You need to publish your Public GPG Keys in several place used by different tools for verifying release signatures.</p> <p>All Your historical Public Keys should be available for verifying historical releases, so please <b>don't remove</b> any key used sometime.</p> -<p>All new <b>RSA</b> keys generated should be at least <b>4096</b> bits. Do not generate new DSA keys.</p><section> +<p>All new <b>RSA</b> keys generated should be at least <b>4096</b> bits. Do not generate new DSA keys.</p><section><a id="Maven_Project_Keys"></a> <h2>Maven Project Keys</h2> <p>Public Keys used for signing Maven core, plugins and shared components are available for users at:<br /><a class="externalLink" href="https://downloads.apache.org/maven/KEYS";>https://downloads.apache.org/maven/KEYS</a></p> <p>You need edit a file and follow provided instructions in SVN at:<br /><a class="externalLink" href="https://svn.apache.org/repos/asf/maven/project/KEYS";>https://svn.apache.org/repos/asf/maven/project/KEYS</a></p> <p>General ASF instruction</p> <ul> <li><a class="externalLink" href="https://infra.apache.org/openpgp.html#update-KEYS";>Update keys on the next release</a></li> -<li><a class="externalLink" href="https://infra.apache.org/release-signing.html#keys-policy";>The KEYS File</a></li></ul></section><section> +<li><a class="externalLink" href="https://infra.apache.org/release-signing.html#keys-policy";>The KEYS File</a></li></ul></section><section><a id="Distributing_Your_Public_Keys"></a> <h2>Distributing Your Public Keys</h2> <p>Your Public Keys <b>MUST</b> be available at public key server, you can use one or even all of currently common used key server</p> <ul> <li><a class="externalLink" href="https://keys.openpgp.org";>https://keys.openpgp.org</a></li> <li><a class="externalLink" href="https://keyserver.ubuntu.com";>https://keyserver.ubuntu.com</a></li> -<li><a class="externalLink" href="https://pgp.mit.edu";>https://pgp.mit.edu</a></li></ul></section><section> +<li><a class="externalLink" href="https://pgp.mit.edu";>https://pgp.mit.edu</a></li></ul></section><section><a id="Committer_public_key_files"></a> <h2>Committer public key files</h2> <p>You should also add Your Public Keys to <a class="externalLink" href="https://people.apache.org/keys/committer";>ASF Committer public key files</a></p> -<p>Please follow instructions at: <a class="externalLink" href="https://people.apache.org/keys";>https://people.apache.org/keys</a></p></section><section> +<p>Please follow instructions at: <a class="externalLink" href="https://people.apache.org/keys";>https://people.apache.org/keys</a></p></section><section><a id="Generate_a_new_key"></a> <h2>Generate a new key</h2> <p>Please follow ASF infrastructure instruction:</p> <ul> Modified: maven/website/content/developers/retirement-plan-plugins.html ============================================================================== --- maven/website/content/developers/retirement-plan-plugins.html (original) +++ maven/website/content/developers/retirement-plan-plugins.html Sat May 11 11:53:23 2024 @@ -2,17 +2,17 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/apt/developers/retirement-plan-plugins.apt at 2024-05-11 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M18 from content/apt/developers/retirement-plan-plugins.apt at 2024-05-11 | Rendered using Apache Maven Fluido Skin 2.0.0-M6 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> - <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M10" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M18" /> <meta name="author" content="Dennis Lundberg" /> <meta name="date" content="2013-07-26" /> - <title>Maven â Retirement Plan for Plugins</title> + <title>Maven</title> <link rel="stylesheet" href="../css/apache-maven-fluido-2.0.0-M6.min.css" /> <link rel="stylesheet" href="../css/site.css" /> <link rel="stylesheet" href="../css/print.css" media="print" /> @@ -39,8 +39,10 @@ <div class="container-fluid"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../images/apache-maven-project.png" alt="Apache Maven Site" style="" /></a></div> - <div class="pull-right"><a href=".././" id="bannerRight"><img src="../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><h1>Apache Maven Site</h1> +</a></div> + <div class="pull-right"><a href=".././" id="bannerRight"><h1>$esc.xml( $banner.name )</h1> +</a></div> <div class="clear"><hr/></div> </div> @@ -48,7 +50,8 @@ <ul class="breadcrumb"> <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class="active ">Retirement Plan for Plugins <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/retirement-plan-plugins.apt";><img src="../images/accessories-text-editor.png" title="Edit" /></a></li> + + <li class="active ">Maven <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/retirement-plan-plugins.apt";><img src="../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-11</li> <li class="pull-right"><span class="divider">|</span> <a href="../scm.html" title="Get Sources">Get Sources</a></li> @@ -145,17 +148,16 @@ </div> </header> <main id="bodyColumn" class="span10" > -<section> -<h1>Retirement Plan for Plugins</h1><section> +<section><a id="Retirement_Plan_for_Plugins"></a> +<h1>Retirement Plan for Plugins</h1><section><a id="Decide_to_retire"></a> <h2>Decide to retire</h2> <p>Propose a vote on the dev-list to retire a plugin. The vote should be open for the standard 72 hours to allow people to voice their opinions. Send a cc to the users-list. Standard Apache voting rules apply. Only PMC votes are binding.</p> <p>The vote must contain one or more options on how to retire the plugin. There are multiple scenarios available. Here are a couple that have been suggested:</p> -<ol style="list-style-type: upper-alpha"> +<ol style="list-style-type: upper-alpha;"> <li>Move to our retired area in svn</li> <li>Move to another Apache project</li> <li>Move to www.mojohaus.org, apache-extras.org or another forge</li></ol> <p>Here's a template for scenario A that can be used for the vote email:</p> -<div class="verbatim"> <pre>To: "Maven Developers List" <d...@maven.apache.org> Cc: "Maven Users List" <us...@maven.apache.org> Subject: [VOTE] Retire Maven Foo Plugin @@ -177,9 +179,8 @@ https://maven.apache.org/developers/reti The vote is open for 72 hours. [ ] +1 Yes, it's about time -[ ] -1 No, because...</pre></div> +[ ] -1 No, because...</pre> <p>If the vote is successful, post the result to the dev list and cc the PMC and users list. For instance:</p> -<div class="verbatim"> <pre>To: "Maven Developers List" <d...@maven.apache.org> Cc: "Maven Users List" <us...@maven.apache.org> CC: "Maven Project Management Committee List" <priv...@maven.apache.org> @@ -192,25 +193,23 @@ The vote has passed with the following r +1 (binding): <<list of names>> +1 (non binding): <<list of names>> -I will continue with the steps required to retire this plugin.</pre></div> -<p>If the vote passes, make one final release of the plugin (with its own standard 72h vote on source release) before it is retired. This allows us to make a clean break. The person who wants to retire a plugin is the one who does the final release. Below you will find the extra steps that you need to follow when retiring a plugin, in addition to <a href="./release/maven-project-release-procedure.html">our standard release process</a>.</p></section><section> +I will continue with the steps required to retire this plugin.</pre> +<p>If the vote passes, make one final release of the plugin (with its own standard 72h vote on source release) before it is retired. This allows us to make a clean break. The person who wants to retire a plugin is the one who does the final release. Below you will find the extra steps that you need to follow when retiring a plugin, in addition to <a href="./release/maven-project-release-procedure.html">our standard release process</a>.</p></section><section><a id="Make_the_final_release"></a> <h2>Make the final release</h2> -<ol style="list-style-type: decimal"> +<ol style="list-style-type: decimal;"> <li>Create an issue in JIRA with the issue type "Task" and the summary "Retire this plugin", and schedule it for the final release. If the plugin includes a JIRA report in the generated site, you will need to close this issue before you make the release.</li> <li>Add the description "This is the final version of this plugin. It has been retired." to the final version in JIRA.</li> <li>Add a prominent notice on the front page of the plugin's site, informing that the plugin is retired. Suggested text: -<div class="verbatim"> -<pre>Note: This plugin is retired. It is no longer maintained.</pre></div> +<pre>Note: This plugin is retired. It is no longer maintained.</pre> <p>If the plugin is moved elsewhere, that should also be added to the plugin's site. Suggested text:</p> -<div class="verbatim"> <pre>Note: This plugin has retired from the Apache Maven project, -but has moved to the <Organization> <Project> project.</pre></div></li> +but has moved to the <Organization> <Project> project.</pre></li> <li>Add " (RETIRED)" at the end of <code><project></code>/<code><name></code> in the plugin's <code>pom.xml</code>. This will show up on every page of the generated site.</li> <li>Go ahead with <a href="./release/maven-project-release-procedure.html">the standard release process</a>, making sure that you follow the exceptions mentioned above regarding the site deployment.</li> <li>When updating the plugins page, move Maven Foo Plugin to under the "Retired" heading. Remove the SVN and JIRA links and add the date of retirement.</li> -<li>When updating the version in JIRA, do not add Y.Z+1 and make sure you remove any future versions.</li></ol></section><section> +<li>When updating the version in JIRA, do not add Y.Z+1 and make sure you remove any future versions.</li></ol></section><section><a id="Clean_up_after_the_release"></a> <h2>Clean up after the release</h2> -<ol style="list-style-type: decimal"> +<ol style="list-style-type: decimal;"> <li>Remove the <code>.Jenkinsfile</code> from all branches. This will remove the project from https://builds.apache.org/job/maven-box/</li> <li>Remove the <code>.github</code> directory from default branch. This will remove GitHub Actions</li> <li>Ask INFRA for archive git repos (gitbox + github)</li> @@ -220,7 +219,7 @@ but has moved to the <Organization> <li>Put the JIRA project in read-only mode in case of standalone project (own Jira key): apply Maven Retired Project Permissions Scheme. (Requires JIRA admin karma: e.g. ask Brian Fox)</li> <li>Comment the <a class="externalLink" href="https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-dist-tool/job/master/site/dist-tool.conf.html";>dist-tool configuration</a> entry.</li> <li>Remove from <code>Source Repository</code> -<ol style="list-style-type: upper-alpha"> +<ol style="list-style-type: upper-alpha;"> <li><a class="externalLink" href="https://maven.apache.org/scm.html";>https://maven.apache.org/scm.html</a></li> <li><a class="externalLink" href="https://github.com/apache/maven-sources";>https://github.com/apache/maven-sources</a></li></ol></li> <li>Remove distribution from current <a class="externalLink" href="https://dist.apache.org/repos/dist/release/maven/";>dist area</a> (history remains available in <a class="externalLink" href="https://archive.apache.org/dist/maven/";>archive</a>).</li> Modified: maven/website/content/developers/website/component-reference-documentation-helper.html ============================================================================== --- maven/website/content/developers/website/component-reference-documentation-helper.html (original) +++ maven/website/content/developers/website/component-reference-documentation-helper.html Sat May 11 11:53:23 2024 @@ -2,15 +2,15 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/markdown/developers/website/component-reference-documentation-helper.md at 2024-05-11 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M18 from content/markdown/developers/website/component-reference-documentation-helper.md at 2024-05-11 | Rendered using Apache Maven Fluido Skin 2.0.0-M6 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> - <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M10" /> - <title>Maven â Preparing Component Release Documentation</title> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M18" /> + <title>Maven</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-2.0.0-M6.min.css" /> <link rel="stylesheet" href="../../css/site.css" /> <link rel="stylesheet" href="../../css/print.css" media="print" /> @@ -37,8 +37,10 @@ <div class="container-fluid"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven Site" style="" /></a></div> - <div class="pull-right"><a href="../.././" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><h1>Apache Maven Site</h1> +</a></div> + <div class="pull-right"><a href="../.././" id="bannerRight"><h1>$esc.xml( $banner.name )</h1> +</a></div> <div class="clear"><hr/></div> </div> @@ -46,7 +48,8 @@ <ul class="breadcrumb"> <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class="active ">Preparing Component Release Documentation <a href="https://github.com/apache/maven-site/tree/master/content/markdown/developers/website/component-reference-documentation-helper.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + + <li class="active ">Maven <a href="https://github.com/apache/maven-site/tree/master/content/markdown/developers/website/component-reference-documentation-helper.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-11</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -140,155 +143,7 @@ </div> </header> <main id="bodyColumn" class="span10" > -<section><section> -<h2>Preparing Component Release Documentation</h2><!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - -<p>select component category, then type artifact id and version to generate svn commands:</p> - -<table class="table table-striped"> - -<tr class="a"> -<td> <section> -<h3>Component category</h3> - -<ul> - -<li><a href="?core">core</a></li> - -<li><a href="?shared">shared components</a></li> - -<li><a href="?plugins">plugins</a></li> - -<li><a href="?pom">poms</a></li> - -<li><a href="?resolver">resolver</a></li> - -<li><a href="?skins">skins</a></li> - -<li><a href="?doxia">Doxia</a></li> - -<li><a href="?doxia-sitetools">Doxia Sitetools</a></li> - -<li><a href="?doxia-tools">Doxia Tools</a></li> - -<li><a href="?others">others</a></li> -</ul> -</td> -<td> -</section><section> -<h3>Component information</h3> - -<p>directory (~artifact id): <input type="text" name="artifactId" id="artifactId" /></input><br /> -version: <input type="text" name="version" id="version" /></input><br /> -<button onclick="instructions()">Publish instructions</button></p> -</td></tr> - -<tr class="b"> -<td colspan="3"> -</section><section> -<h3>instructions to publish component release documentation</h3> - -<div class="verbatim"> -<pre id="svnmucc">svnmucc -m "Publish ${artifactId} ${version} documentation" \ - -U https://svn.apache.org/repos/asf/maven/website/components \ - cp HEAD ${category}-archives/${artifactId}-LATEST ${category}-archives/${artifactId}-${version} \ - rm ${category}/${artifactId} \ - cp HEAD ${category}-archives/${artifactId}-LATEST ${category}/${artifactId}</pre></div> -</td></tr> - -<tr class="a"> -<td colspan="2"><iframe id="index-page" src="" width="100%" height="300px"></iframe></td> - -<td>archives directory<br /> -<iframe id="archives" src="" width="100%" height="300px"></iframe> -</td> -</tr> -</table> -<script type="text/javascript"> -//<![CDATA[ -function selectCategory(index, archive) { - var indexPage = document.getElementById('index-page'); - var linkIndexPage = document.getElementById('link-index-page'); - var archives = document.getElementById('archives'); - var indexUrl = index ? ('https://maven.apache.org/' + index) : ''; - indexPage.setAttribute('src', indexUrl); - archives.setAttribute('src', 'https://maven.apache.org/' + archive + '?C=M;O=D'); - instructions(); -} - -function escapeRegExp(string) { - return string.replace(/([.*+?^=!:${}()|\[\]\/\\])/g, "\\$1"); -} -function replaceAll(string, find, replace) { - return string.replace(new RegExp(escapeRegExp(find), 'g'), replace); -} - -function instructions() { - var category = document.location.search.substr(1); - var artifactId = document.getElementById('artifactId').value; - var version = document.getElementById('version').value; - var svnmucc = svnmuccTemplate; - if (category == "core") { - artifactId = "Maven"; - svnmucc = svnmucc.substr(0, svnmucc.indexOf(" rm ")) - svnmucc = replaceAll(svnmucc, '${artifactId}-LATEST', '3-LATEST'); - svnmucc = replaceAll(svnmucc, '${category}-archives', 'ref'); - svnmucc = replaceAll(svnmucc, '${artifactId}-${version} \\', '${version}\n\n'); - } - if (category.indexOf("doxia") == 0) { - svnmucc = replaceAll(svnmucc, 'maven/website/components', 'maven/doxia/website/components'); - if (category != "doxia-tools") { - document.getElementById('artifactId').value = category; - } - } - if (category == "resolver" || category == "others" || category == "doxia" || category == "doxia-sitetools") { - // category directory is based on artifactId - svnmucc = replaceAll(svnmucc, '${category}/${artifactId}', '${artifactId}'); - svnmucc = replaceAll(svnmucc, '${category}', '${artifactId}'); - } - svnmucc = replaceAll(svnmucc, '${category}', category); - if (artifactId) { - svnmucc = replaceAll(svnmucc, '${artifactId}', artifactId); - } - if (version) { - svnmucc = replaceAll(svnmucc, '${version}', version); - } - document.getElementById('svnmucc').innerHTML = svnmucc; -} - -var category = document.location.search.substr(1); -var svnmuccTemplate = document.getElementById('svnmucc').innerHTML; - -if (category == "core") { - selectCategory('docs/history.html', 'ref/'); -} else if (category.indexOf("doxia") == 0) { - selectCategory('doxia/' + category + '/', 'doxia/' + category + '-archives/'); -} else if (category == "others") { - selectCategory('', 'components/'); -} else if (category != "") { - selectCategory(category + '/', category+'-archives/'); -} -//]]> -</script> -</section></section></section> </main> </div> </div> Modified: maven/website/content/developers/website/deploy-component-reference-documentation.html ============================================================================== --- maven/website/content/developers/website/deploy-component-reference-documentation.html (original) +++ maven/website/content/developers/website/deploy-component-reference-documentation.html Sat May 11 11:53:23 2024 @@ -2,18 +2,18 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/apt/developers/website/deploy-component-reference-documentation.apt at 2024-05-11 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M18 from content/apt/developers/website/deploy-component-reference-documentation.apt at 2024-05-11 | Rendered using Apache Maven Fluido Skin 2.0.0-M6 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> - <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M10" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M18" /> <meta name="author" content="Barrie Treloar" /> <meta name="author" content="Hervé Boutemy" /> <meta name="date" content="2015-03-30" /> - <title>Maven â Deploy Maven Component Reference Documentation</title> + <title>Maven</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-2.0.0-M6.min.css" /> <link rel="stylesheet" href="../../css/site.css" /> <link rel="stylesheet" href="../../css/print.css" media="print" /> @@ -40,8 +40,10 @@ <div class="container-fluid"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven Site" style="" /></a></div> - <div class="pull-right"><a href="../.././" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><h1>Apache Maven Site</h1> +</a></div> + <div class="pull-right"><a href="../.././" id="bannerRight"><h1>$esc.xml( $banner.name )</h1> +</a></div> <div class="clear"><hr/></div> </div> @@ -49,7 +51,8 @@ <ul class="breadcrumb"> <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class="active ">Deploy Maven Component Reference Documentation <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/website/deploy-component-reference-documentation.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + + <li class="active ">Maven <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/website/deploy-component-reference-documentation.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-11</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -143,65 +146,59 @@ </div> </header> <main id="bodyColumn" class="span10" > -<section> +<section><a id="Introduction"></a> <h1>Introduction</h1> <p>This document gives step-by-step instructions for deploying Maven components reference documentation inside the Maven <a href="/">https://maven.apache.org/</a> website.</p> -<p>See <a href="./index.html">Maven website introduction</a> for instructions on the whole website publication (main site content + components).</p></section><section> +<p>See <a href="./index.html">Maven website introduction</a> for instructions on the whole website publication (main site content + components).</p></section><section><a id="Overview"></a> <h1>Overview</h1> -<p>Since December 2012, the overall website uses svnpubsub mechanism:</p><figure><img src="component-reference-documentation.png" /><figcaption>Components reference documentation mechanisms overview</figcaption></figure></section><section> +<p>Since December 2012, the overall website uses svnpubsub mechanism:</p><figure><img src="component-reference-documentation.png" /><figcaption>Components reference documentation mechanisms overview</figcaption></figure></section><section><a id="How_components_reference_documentation_publication_works"></a> <h1>How components reference documentation publication works</h1> -<p>Components don't use CMS: components reference documentation are versioned and generated from full sources, with both handwritten content (like Maven main site) and content generated from sources (javadoc, unit-test results, integration test results...).</p><section> +<p>Components don't use CMS: components reference documentation are versioned and generated from full sources, with both handwritten content (like Maven main site) and content generated from sources (javadoc, unit-test results, integration test results...).</p><section><a id="Staging_component_reference_documentation"></a> <h2>Staging component reference documentation</h2> <p>Reference documentation of a component is staged in <code>https://maven.apache.org/xxx-archives/yyy-LATEST/</code>, where <code>yyy</code> is the component name and <code>xxx</code> can be:</p> <ul> <li>the component type, like <code>shared</code>, <code>plugins</code>, <code>skins</code>, ... (see <a href="/shared-archives/">/shared-archives/</a>, <a href="/plugins-archives/">/plugins-archives/</a>, <a href="/pom-archives/">/pom-archives/</a>, <a href="/skins-archives/">/skins-archives/</a>)</li> <li>the component name for standalone components, like <code>archetype</code>, <code>plugin-tools</code>, <code>surefire</code>, <code>wagon</code>, ... (see <a href="/archetype-archives/">/archetype-archives/</a>, <a href="/archetypes-archives/">/archetypes-archives/</a>, <a href="/plugin-tools-archives/">/plugin-tools-archives/</a>, <a href="/scm-archives/">/scm-archives/</a>, <a href="/surefire-archives/">/surefire-archives/</a>, <a href="/wagon-archives/">/wagon-archives/</a>)</li></ul> <p>To publish component reference documentation:</p> -<ol style="list-style-type: decimal"> +<ol style="list-style-type: decimal;"> <li>prerequisite: eventually build the component if it has not been done previously, or some reports may miss build or integration information: <p>Notice: In cases where you have prepared a release you can simple change into <code>target/checkout</code> directory and continue with 2.</p> -<div class="verbatim"> -<pre>mvn -Prun-its install</pre></div></li> +<pre>mvn -Prun-its install</pre></li> <li>build the reference documentation: -<div class="verbatim"> -<pre>mvn -Preporting site site:stage</pre></div> +<pre>mvn -Preporting site site:stage</pre> <p>Notice: <code>site:stage</code> is really necessary only for multi-modules components, but added unconditionally in these instructions to keep them as straightforward as possible.</p></li> <li>stage the reference documentation to website production svn area, using <a href="/plugins/maven-scm-publish-plugin">maven-scm-publish-plugin</a>: (TODO: explanations on configuration in pom to yyy-LATEST) -<div class="verbatim"> -<pre>mvn scm-publish:publish-scm</pre></div> +<pre>mvn scm-publish:publish-scm</pre> <p>svnpubsub mechanism transfers svn production content to live production site</p></li></ol> -<p><b>Notice</b>: content is in fact published to <a href="/components/">/components/</a> directory, and symbolic links declared in <code>resources/**/components.links</code> in main site source are used by Ant to create a reference from <code>/xxx</code> (= what we want to be user-visible) to <code>/components/xxx</code> (what what is checked out).</p></section><section> +<p><b>Notice</b>: content is in fact published to <a href="/components/">/components/</a> directory, and symbolic links declared in <code>resources/**/components.links</code> in main site source are used by Ant to create a reference from <code>/xxx</code> (= what we want to be user-visible) to <code>/components/xxx</code> (what what is checked out).</p></section><section><a id="Publishing_versioned_component_reference_documentation"></a> <h2>Publishing versioned component reference documentation</h2> <p>When doing a release, <code>yyy-LATEST</code> content staged in previous section needs:</p> -<ol style="list-style-type: decimal"> +<ol style="list-style-type: decimal;"> <li>to be archived to versioned directory before a newer revision is published into -LATEST,</li> <li>to replace the actual component reference documentation.</li></ol> <p>This is done with operations on website production svn area: you can use <a href="./component-reference-documentation-helper.html">Component Reference Documentation Helper</a> to easily prepare svnmucc command line.</p> <p>If you prefer to do everything by hand from command templates, you can do either with <code>svn</code> command:</p> <ul> <li>Unix: -<div class="verbatim"> <pre>SVNPUBSUB=https://svn.apache.org/repos/asf/maven/website/components svn cp $SVNPUBSUB/xxx-archives/yyy-LATEST $SVNPUBSUB/xxx-archives/yyy-$version -m "Archive versioned site." svn rm $SVNPUBSUB/xxx/yyy -m "Remove old site." -svn cp $SVNPUBSUB/xxx-archives/yyy-$version $SVNPUBSUB/xxx/yyy -m "Publish new site."</pre></div></li> +svn cp $SVNPUBSUB/xxx-archives/yyy-$version $SVNPUBSUB/xxx/yyy -m "Publish new site."</pre></li> <li>Windows: -<div class="verbatim"> <pre>set SVNPUBSUB=https://svn.apache.org/repos/asf/maven/website/components svn cp %SVNPUBSUB%/xxx-archives/yyy-LATEST %SVNPUBSUB%/xxx-archives/yyy-$version -m "Archive versioned site." svn rm %SVNPUBSUB%/xxx/yyy -m "Remove old site." -svn cp %SVNPUBSUB%/xxx-archives/yyy-$version %SVNPUBSUB%/xxx/yyy -m "Publish new site."</pre></div></li></ul> +svn cp %SVNPUBSUB%/xxx-archives/yyy-$version %SVNPUBSUB%/xxx/yyy -m "Publish new site."</pre></li></ul> <p>or with <a class="externalLink" href="http://svnbook.red-bean.com/en/1.8/svn.ref.svnmucc.re.html";><code>svnmucc</code> command</a>:</p> -<div class="verbatim"> <pre>svnmucc -m "Publish yyy $version documentation" \ -U https://svn.apache.org/repos/asf/maven/website/components \ cp HEAD xxx-archives/yyy-LATEST xxx-archives/yyy-$version \ rm xxx/yyy \ - cp HEAD xxx-archives/yyy-LATEST xxx/yyy</pre></div></section><section> + cp HEAD xxx-archives/yyy-LATEST xxx/yyy</pre></section><section><a id="Updating_index_page_in_the_Maven_site"></a> <h2>Updating index page in the Maven site</h2> <p>Some component types have an index page refering to each components of the same type. This is the case for plugins (see <a href="/plugins/">index</a>), shared (see <a href="/shared/">index</a>), poms (see <a href="/pom/">index</a>) and skins (see <a href="/skins/">index</a>).</p> <p>Update the version number and release date for the component in the <code>content/apt/xxx/index.apt</code> page.</p> Modified: maven/website/content/developers/website/deploy-maven-website.html ============================================================================== --- maven/website/content/developers/website/deploy-maven-website.html (original) +++ maven/website/content/developers/website/deploy-maven-website.html Sat May 11 11:53:23 2024 @@ -2,18 +2,18 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/apt/developers/website/deploy-maven-website.apt at 2024-05-11 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M18 from content/apt/developers/website/deploy-maven-website.apt at 2024-05-11 | Rendered using Apache Maven Fluido Skin 2.0.0-M6 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> - <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M10" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M18" /> <meta name="author" content="Barrie Treloar" /> <meta name="author" content="Hervé Boutemy" /> <meta name="date" content="2015-03-30" /> - <title>Maven â Deploy Maven Main Website</title> + <title>Maven</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-2.0.0-M6.min.css" /> <link rel="stylesheet" href="../../css/site.css" /> <link rel="stylesheet" href="../../css/print.css" media="print" /> @@ -40,8 +40,10 @@ <div class="container-fluid"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven Site" style="" /></a></div> - <div class="pull-right"><a href="../.././" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><h1>Apache Maven Site</h1> +</a></div> + <div class="pull-right"><a href="../.././" id="bannerRight"><h1>$esc.xml( $banner.name )</h1> +</a></div> <div class="clear"><hr/></div> </div> @@ -49,7 +51,8 @@ <ul class="breadcrumb"> <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class="active ">Deploy Maven Main Website <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/website/deploy-maven-website.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + + <li class="active ">Maven <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/website/deploy-maven-website.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-11</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -129,18 +132,18 @@ </div> </header> <main id="bodyColumn" class="span10" > -<section> +<section><a id="Introduction"></a> <h1>Introduction</h1> <p>This document gives step-by-step instructions for deploying the main Maven <a href="/">https://maven.apache.org</a> website.</p> <p><b>Obsolete</b> this documentation is obsolete: with the migration of site source to Git, Apache CMS is not used any more. It is replaced by Git edit (eventually through GitHub with the "edit" link accessible from breadcrumb) followed by Jenkins job to build and commit to svnpubsub.</p> -<p>See <a href="./index.html">Maven website introduction</a> for instructions on the whole website publication.</p></section><section> +<p>See <a href="./index.html">Maven website introduction</a> for instructions on the whole website publication.</p></section><section><a id="Overview"></a> <h1>Overview</h1> -<p>Since December 2012, the overall website uses svnpubsub mechanism and the main website uses Apache CMS:</p><figure><img src="main-website.png" /><figcaption>Main website mechanisms overview</figcaption></figure></section><section> +<p>Since December 2012, the overall website uses svnpubsub mechanism and the main website uses Apache CMS:</p><figure><img src="main-website.png" /><figcaption>Main website mechanisms overview</figcaption></figure></section><section><a id="How_main_website_publication_works"></a> <h1>How main website publication works</h1> -<p>Maven main website (<a class="externalLink" href="https://maven.apache.org";>https://maven.apache.org</a>) is generated with <a href="/plugins/maven-site-plugin">maven-site-plugin</a> from a source tree stored in svn: <a class="externalLink" href="https://svn.apache.org/repos/asf/maven/site/trunk";>https://svn.apache.org/repos/asf/maven/site/trunk</a>.</p><section> +<p>Maven main website (<a class="externalLink" href="https://maven.apache.org";>https://maven.apache.org</a>) is generated with <a href="/plugins/maven-site-plugin">maven-site-plugin</a> from a source tree stored in svn: <a class="externalLink" href="https://svn.apache.org/repos/asf/maven/site/trunk";>https://svn.apache.org/repos/asf/maven/site/trunk</a>.</p><section><a id="Edit_source_content"></a> <h2>Edit source content</h2> <p>You can edit source content in 2 ways:</p> -<ol style="list-style-type: decimal"> +<ol style="list-style-type: decimal;"> <li>use <a class="externalLink" href="https://cms.apache.org/maven/";>the CMS UI</a> through your web browser: <ul> <li>Go to <a class="externalLink" href="https://cms.apache.org/maven/";>https://cms.apache.org/maven/</a>.</li> @@ -149,16 +152,16 @@ <li>Once you have modified the content, commit with the button "Submit".</li></ul></li> <li>checkout the source content locally, modify it with your favorite text editor, eventually test the result (<code>mvn site</code>), then check-in source modifications.</li></ol> <p>After source tree is modified in svn, <a class="externalLink" href="http://ci.apache.org/builders/maven-site-staging";>a Buildbot job</a> is triggered: </p> -<ol style="list-style-type: decimal"> +<ol style="list-style-type: decimal;"> <li>it builds the HTML site using <a href="/plugins/maven-site-plugin">maven-site-plugin</a>: <code>mvn site</code>,</li> <li>it publishes generated HTML content to <a class="externalLink" href="https://svn.apache.org/repos/infra/websites/staging/maven/trunk/content/";>CMS staging svn area</a>,</li> -<li>svnpubsub mecanism transfers svn CMS staging content to live CMS staging site: <a class="externalLink" href="http://maven.staging.apache.org";>http://maven.staging.apache.org</a>,</li></ol></section><section> +<li>svnpubsub mecanism transfers svn CMS staging content to live CMS staging site: <a class="externalLink" href="http://maven.staging.apache.org";>http://maven.staging.apache.org</a>,</li></ol></section><section><a id="Publish_site_content"></a> <h2>Publish site content</h2> <p>If everything is good, <b>publish modifications</b> using <a class="externalLink" href="https://cms.apache.org/maven/publish";>CMS publish</a> action.</p> <p>Under the hood:</p> -<ol style="list-style-type: decimal"> +<ol style="list-style-type: decimal;"> <li>CMS copies CMS staging svn area content to <a class="externalLink" href="https://svn.apache.org/repos/infra/websites/production/maven/content/";>website production svn area</a>,</li> -<li>svnpubsub mecanism transfers svn production content to live production site: <a class="externalLink" href="http://maven.apache.org";>http://maven.apache.org</a>.</li></ol></section></section><section> +<li>svnpubsub mecanism transfers svn production content to live production site: <a class="externalLink" href="http://maven.apache.org";>http://maven.apache.org</a>.</li></ol></section></section><section><a id="How_Doxia_website_publication_works"></a> <h1>How Doxia website publication works</h1> <p>Doxia uses the exact same mecanisms:</p> <ul> Modified: maven/website/content/developers/website/index.html ============================================================================== --- maven/website/content/developers/website/index.html (original) +++ maven/website/content/developers/website/index.html Sat May 11 11:53:23 2024 @@ -2,18 +2,18 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/apt/developers/website/index.apt at 2024-05-11 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M18 from content/apt/developers/website/index.apt at 2024-05-11 | Rendered using Apache Maven Fluido Skin 2.0.0-M6 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> - <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M10" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M18" /> <meta name="author" content="Barrie Treloar" /> <meta name="author" content="Hervé Boutemy" /> <meta name="date" content="2013-09-23" /> - <title>Maven â Deploy Maven Website</title> + <title>Maven</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-2.0.0-M6.min.css" /> <link rel="stylesheet" href="../../css/site.css" /> <link rel="stylesheet" href="../../css/print.css" media="print" /> @@ -40,8 +40,10 @@ <div class="container-fluid"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven Site" style="" /></a></div> - <div class="pull-right"><a href="../.././" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><h1>Apache Maven Site</h1> +</a></div> + <div class="pull-right"><a href="../.././" id="bannerRight"><h1>$esc.xml( $banner.name )</h1> +</a></div> <div class="clear"><hr/></div> </div> @@ -49,7 +51,8 @@ <ul class="breadcrumb"> <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class="active ">Deploy Maven Website <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/website/index.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + + <li class="active ">Maven <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/website/index.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-11</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -143,7 +146,7 @@ </div> </header> <main id="bodyColumn" class="span10" > -<section> +<section><a id="Introduction"></a> <h1>Introduction</h1> <p>The Maven <a class="externalLink" href="https://maven.apache.org";>https://maven.apache.org</a> website is composed from:</p> <ul> @@ -156,12 +159,12 @@ <li><a class="externalLink" href="https://maven.apache.org/components";><code>/components</code></a> comes from <a class="externalLink" href="https://svn.apache.org/repos/asf/maven/website/components/";>https://svn.apache.org/repos/asf/maven/website/components/</a></li> <li><code>/doxia</code> comes from <a class="externalLink" href="https://svn.apache.org/viewvc/maven/doxia/website/content/";>https://svn.apache.org/repos/asf/maven/doxia/website/content/</a></li> <li><a class="externalLink" href="https://maven.apache.org/doxia/components";><code>/doxia/components</code></a> comes from <a class="externalLink" href="https://svn.apache.org/repos/asf/maven/doxia/website/components/";>https://svn.apache.org/repos/asf/maven/doxia/website/components/</a></li></ul> -<p>and the link between main content and components reference documentation (for example from <code>/plugins/maven-xxx-plugin</code> to internal <code>/components/plugins/maven-xxx-plugin</code>) is done with symbolic links. These links are configured in <code>components.links</code> files in <code>content/resources/</code> and subdirectories, for example <a class="externalLink" href="https://github.com/apache/maven-site/blob/master/content/resources/plugins/components.links";>plugins/components.links</a>.</p></section><section> +<p>and the link between main content and components reference documentation (for example from <code>/plugins/maven-xxx-plugin</code> to internal <code>/components/plugins/maven-xxx-plugin</code>) is done with symbolic links. These links are configured in <code>components.links</code> files in <code>content/resources/</code> and subdirectories, for example <a class="externalLink" href="https://github.com/apache/maven-site/blob/master/content/resources/plugins/components.links";>plugins/components.links</a>.</p></section><section><a id="How_website_publication_works"></a> <h1>How website publication works</h1> <p>Instructions on how to publish website content are split in separate documents:</p> <ul> <li>on every main content source commit (<a class="externalLink" href="https://github.com/apache/maven-site";>maven-site.git</a> and <a class="externalLink" href="https://github.com/apache/maven-doxia-site";>maven-doxia-site.git</a>), main content rebuild and publish is triggered through Jenkins jobs ( <a class="externalLink" href="https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-site/";>maven-site job</a> and <a class="externalLink" href="https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-doxia-site/";>doxia-site job</a>), which basically run <code>mvn site-deploy</code> (it can be run locally if CI is off...),</li> -<li>on every Maven component release, release manager follows "<a href="./deploy-component-reference-documentation.html">deploying Maven components reference documentation</a>", eventually using <a href="./component-reference-documentation-helper.html">Component Reference Documentation Helper</a> to easily prepare <code>svnmucc</code> command line.</li></ul></section><section> +<li>on every Maven component release, release manager follows "<a href="./deploy-component-reference-documentation.html">deploying Maven components reference documentation</a>", eventually using <a href="./component-reference-documentation-helper.html">Component Reference Documentation Helper</a> to easily prepare <code>svnmucc</code> command line.</li></ul></section><section><a id="Analytics"></a> <h1>Analytics</h1> <p>As part of Privacy enhancements, the whole Maven site is moving to <a class="externalLink" href="https://privacy.apache.org/matomo/";>Apache's Analytics infrastructure</a>: see <a class="externalLink" href="https://analytics.apache.org/index.php?module=CoreHome&action=index&date=yesterday&period=day&idSite=3";>Maven statistics</a>.</p></section> </main>
