Modified: maven/website/content/guides/development/guide-helping.html ============================================================================== --- maven/website/content/guides/development/guide-helping.html (original) +++ maven/website/content/guides/development/guide-helping.html Sat Feb 18 20:40:58 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/development/guide-helping.md at 2023-02-18 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/development/guide-helping.apt at 2023-02-18 | Rendered using Apache Maven Fluido Skin 1.11.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang=""> @@ -10,8 +10,10 @@ <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-M4" /> - <meta name="author" content="Brett Porter, Jason van Zyl" /> - <meta name="date" content="2008-07-03, 2015-06-16" /> + <meta name="author" content="Brett Porter +Jason van Zyl" /> + <meta name="date" content="2008-07-03 +2015-06-16" /> <title>Maven – Guide to helping with Maven</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-1.11.1.min.css" /> <link rel="stylesheet" href="../../css/site.css" /> @@ -48,7 +50,7 @@ <ul class="breadcrumb"> <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class="active ">Guide to helping with Maven <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/development/guide-helping.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li class="active ">Guide to helping with Maven <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/development/guide-helping.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-18</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -133,87 +135,41 @@ </div> </header> <main id="bodyColumn" class="span10" > -<!-- -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. ---> -<section><section> -<h2>Guide to helping with Maven</h2> +<section> +<h1>Guide to helping with Maven</h1> <p>As with any open source project, there are several ways you can help:</p> <ul> - -<li> -<p>Join the <a href="../../mailing-lists.html">mailing lists</a> and answer other user's questions.</p></li> -<li> -<p>Report bugs, feature requests and other issues in the <a href="../../issue-management.html">issue management system</a>.</p></li> -<li> -<p><a href="./guide-building-maven.html">Build Maven</a> for yourself, in order to fix bugs.</p></li> -<li> -<p><a href="./guide-maven-development.html#Creating_and_submitting_a_patch">Submit patches</a> to reported issues (both those you find, or that others have filed)<br /> -To ease your first contribution, we have a <a href="https://s.apache.org/for-the-grabs_maven"; class="externalLink">list of “up for grabs” issues</a>, meaning that they should be easy to work on.</p></li> -<li> -<p><a href="./guide-testing-releases.html">test releases</a> help test releases that are being voted on (see the <a href="mailto:[email protected]"; class="externalLink">[email protected]</a> <a href="../../mailing-lists.html">mailing list</a> for release votes)</p></li> -<li> -<p><a href="./guide-testing-development-plugins.html">test snapshot plugins</a> help test the latest development versions of plugins and report issues</p></li> -<li> -<p>Help with the documentation by pointing out areas that are lacking or unclear, and if you can, submitting Pull Requests to correct it: use the “edit” button in the breadcrumb, just after the page title. You can also create appropriate issues <a href="https://issues.apache.org/jira/browse/MNGSITE"; class="externalLink">by using the issue management system</a>.</p></li> -</ul> +<li>Join the <a href="../../mailing-lists.html">mailing lists</a> and answer other user's questions.</li> +<li>Report bugs, feature requests and other issues in the <a href="../../issue-management.html">issue management system</a>.</li> +<li><a href="./guide-building-maven.html"> Build Maven</a> for yourself, in order to fix bugs.</li> +<li><a href="./guide-maven-development.html#Creating_and_submitting_a_patch">Submit patches</a> to reported issues (both those you find, or that others have filed)<br />To ease your first contribution, we have a <a class="externalLink" href="https://s.apache.org/for-the-grabs_maven";>list of "up for grabs" issues</a>, meaning that they should be easy to work on.</li> +<li><a href="./guide-testing-releases.html"> test releases</a> help test releases that are being voted on (see the [email protected] <a href="../../mailing-lists.html"> mailing list</a> for release votes)</li> +<li><a href="./guide-testing-development-plugins.html"> test snapshot plugins</a> help test the latest development versions of plugins and report issues</li> +<li>Help with the documentation by pointing out areas that are lacking or unclear, and if you can, submitting Pull Requests to correct it: use the "edit" button in the breadcrumb, just after the page title. You can also create appropriate issues <a class="externalLink" href="https://issues.apache.org/jira/browse/MNGSITE";>by using the issue management system</a>.</li></ul> <p>Your participation in the community is much appreciated!</p></section><section> -<h2>Why Would I Want to Help?</h2> +<h1>Why Would I Want to Help?</h1> <p>There are several reasons these are good things.</p> <ul> - -<li> -<p>By answering other people's questions, you can learn more for yourself</p></li> -<li> -<p>By submitting your own fixes, they get incorporated faster</p></li> -<li> -<p>By reporting issues, you ensure that bugs don't get missed, or forgotten</p></li> -<li> -<p>You are giving back to a community that has given you software for free</p></li> -</ul></section><section> -<h2>How do I Join the Project?</h2> +<li>By answering other people's questions, you can learn more for yourself</li> +<li>By submitting your own fixes, they get incorporated faster</li> +<li>By reporting issues, you ensure that bugs don't get missed, or forgotten</li> +<li>You are giving back to a community that has given you software for free</li></ul></section><section> +<h1>How do I Join the Project?</h1> <p>Projects at Apache operate under a meritocracy, meaning those that the developers notice participating to a high extent will be invited to join the project as a committer.</p> <p>This is as much based on personality and ability to work with other developers and the community as it is with proven technical ability. Being unhelpful to other users, or obviously looking to become a committer for bragging rights and nothing else is frowned upon, as is asking to be made a committer without having contributed sufficiently to be invited.</p></section><section> -<h2>Developers Conventions</h2> +<h1>Developers Conventions</h1> <p>There are a number of conventions used in the project, which contributors and developers alike should follow for consistency's sake.</p> <ul> - -<li> -<p><a href="../../developers/conventions/code.html">Maven Code Style And Convention</a></p></li> -<li> -<p><a href="../../developers/conventions/jira.html">Maven Jira Convention</a></p></li> -<li> -<p><a href="../../developers/conventions/git.html">Maven Git Convention</a></p></li> -<li> -<p><a href="../../developers/release/index.html">Releasing a Maven project</a></p></li> -<li> -<p><a href="https://cwiki.apache.org/confluence/display/MAVEN/Index"; class="externalLink">Apache Maven Wiki</a></p></li> -</ul></section><section> -<h2>Resources for committers</h2> +<li><a href="../../developers/conventions/code.html">Maven Code Style And Convention</a></li> +<li><a href="../../developers/conventions/jira.html">Maven Jira Convention</a></li> +<li><a href="../../developers/conventions/git.html">Maven Git Convention</a></li> +<li><a href="../../developers/release/index.html">Releasing a Maven project</a></li> +<li><a class="externalLink" href="https://cwiki.apache.org/confluence/display/MAVEN/Index";>Apache Maven Wiki</a></li></ul></section><section> +<h1>Resources for committers</h1> <ul> - -<li> -<p><a href="http://www.apache.org/dev/"; class="externalLink">Developer Resources</a></p></li> -<li> -<p><a href="http://www.apache.org/foundation/"; class="externalLink">About the Apache Software Foundation</a></p></li> -<li> -<p><a href="http://www.apache.org/dev/committers.html"; class="externalLink">Committer FAQ</a></p></li> -</ul></section></section> +<li><a class="externalLink" href="http://www.apache.org/dev/";> Developer Resources</a></li> +<li><a class="externalLink" href="http://www.apache.org/foundation/";> About the Apache Software Foundation</a></li> +<li><a class="externalLink" href="http://www.apache.org/dev/committers.html";> Committer FAQ</a></li></ul></section> </main> </div> </div>
Modified: maven/website/content/guides/development/guide-maven-development.html ============================================================================== --- maven/website/content/guides/development/guide-maven-development.html (original) +++ maven/website/content/guides/development/guide-maven-development.html Sat Feb 18 20:40:58 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/development/guide-maven-development.md at 2023-02-18 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/development/guide-maven-development.apt at 2023-02-18 | Rendered using Apache Maven Fluido Skin 1.11.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang=""> @@ -10,7 +10,10 @@ <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-M4" /> - <meta name="author" content="Emmanuel Venisse, Trygve Laugstol, Brett Porter, Maarten Mulders" /> + <meta name="author" content="Emmanuel Venisse +Trygve Laugstol +Brett Porter +Maarten Mulders" /> <meta name="date" content="2019-06-04" /> <title>Maven – Guide to Developing Maven</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-1.11.1.min.css" /> @@ -48,7 +51,7 @@ <ul class="breadcrumb"> <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class="active ">Guide to Developing Maven <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/development/guide-maven-development.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li class="active ">Guide to Developing Maven <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/development/guide-maven-development.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-18</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -139,119 +142,69 @@ </div> </header> <main id="bodyColumn" class="span10" > -<!-- -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. ---> -<section><section> -<h2>Developing Maven</h2> +<section> +<h1>Developing Maven</h1> <p>This document describes how to get started developing Maven itself. There is a separate page describing how to <a href="./guide-building-maven.html">build Maven</a>.</p><section> -<h3>Finding some work to do</h3> +<h2>Finding some work to do</h2> <p>First of all you need something to work on! Issues can be found in <a href="/issue-management.html">several JIRA projects</a>.</p> -<p>Another good place to look for work is the <a href="https://s.apache.org/up-for-grabs_maven"; class="externalLink">Up for grabs</a> list. This list contains relatively simple issues that can be worked on without a lot of prerequisite knowledge.</p> +<p>Another good place to look for work is the <a class="externalLink" href="https://s.apache.org/up-for-grabs_maven";> Up for grabs</a> list. This list contains relatively simple issues that can be worked on without a lot of prerequisite knowledge. </p> <p>When you find a issue you would like to work on, add a comment in the issue log so the core developers and other people looking for work know that someone is already working on it.</p></section><section> -<h3>Where's the source?</h3> -<p>See <a href="/scm.html">https://maven.apache.org/scm.html</a> for information. The Maven project uses the Apache GitBox Repositories, and all of them are dual-mirrored to <a href="https://github.com/apache/"; class="externalLink">GitHub</a>.</p></section><section> -<h3>Don't forget tests</h3><!-- TODO move details to guide-building-maven.apt, keep only principles here --> - +<h2>Where's the source?</h2> +<p>See <a href="/scm.html">https://maven.apache.org/scm.html</a> for information. The Maven project uses the Apache GitBox Repositories, and all of them are dual-mirrored to <a class="externalLink" href="https://github.com/apache/";> GitHub</a>.</p></section><section> +<h2>Don't forget tests!</h2> <p>You will find many unit tests. If at all possible, create or modify a unit test to demonstrate the problem, and then validate your fix.</p> <p>If you need to mock a class to write a test, use the Mockito framework. Parts of the Maven codebase predate Mockito so you will encounter existing tests that use EasyMock, PowerMock, and JMock. However, all newly written mocks should use Mockito, even if this means a module or a single class uses multiple mocking frameworks. If an existing test class has complicated legacy mock setup, you can add new Mockito based tests in a new test class. There is no requirement that all tests for a single model class must be in the same test class. It is OK to have multiple test classes per model class.</p> <p>If the problem case can't be set up in the unit tests, add an integration test. Before submitting a patch, in any case, you should run all of the integration tests. The tests require an empty local repository. See <a href="/core-its/core-it-suite/">Core IT Suite documentation</a> for more details.</p></section><section> -<h3>Creating and submitting a patch</h3> +<h2><a id="Creating_and_submitting_a_patch">Creating and submitting a patch</a></h2> <p>The most convenient way is to create a GitHub fork from the Git repository you are working with. When you have either completed an issue or just want some feedback on the work you have done, create a pull request. We have a couple of guidelines when submitting contributions:</p> <ul> - -<li> -<p>Verify the status of the <code>master</code> branch on <a href="https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-dist-tool/job/master/site/dist-tool-master-jobs.html"; class="externalLink">Maven CI</a>. If it is not SUCCCESS, then first try to figure out the problem, don't start with your own issue yet! You can use <code>git bisect</code> to figure out the problematic commit and help with that committer to solve the problem.</p></li> -<li> -<p>Create your branch from <code>master</code>, not from a tag. Otherwise, your patch is outdated the moment you create it and might not be applicable to the development head.</p></li> -<li> -<p>If this was a new piece of work without a JIRA issue, create a JIRA issue for it now.</p></li> -<li> -<p>Name the branch after the issue number; the branch name would start with <code><jira-project-id>-<ticket-id></code>.</p></li> -<li> -<p>Push your branch with the commit(s) to your fork.</p></li> -<li> -<p>Create a <a href="https://help.github.com/en/articles/about-pull-requests"; class="externalLink">pull request</a> to submit your contribution. Shortly after, someone will review the pull request and give you feedback on it.</p></li> -</ul> +<li>Verify the status of the <code>master</code> branch on <a class="externalLink" href="https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-dist-tool/job/master/site/dist-tool-master-jobs.html";>Maven CI</a>. If it is not SUCCCESS, then first try to figure out the problem, don't start with your own issue yet! You can use <code>git bisect</code> to figure out the problematic commit and help with that committer to solve the problem.</li> +<li>Create your branch from <code>master</code>, not from a tag. Otherwise, your patch is outdated the moment you create it and might not be applicable to the development head.</li> +<li>If this was a new piece of work without a JIRA issue, create a JIRA issue for it now.</li> +<li>Name the branch after the issue number; the branch name would start with <code><jira-project-id>-<ticket-id></code>.</li> +<li>Push your branch with the commit(s) to your fork.</li> +<li>Create a <a class="externalLink" href="https://help.github.com/en/articles/about-pull-requests";> pull request</a> to submit your contribution. Shortly after, someone will review the pull request and give you feedback on it.</li></ul> <p>A short note:</p> <ul> - -<li>Make sure that you follow our code style, see <a href="#further-links">Further Links</a>.</li> -</ul></section><section> -<h3>Pull request acceptance criteria</h3> +<li>Make sure that you follow our code style, see <a href="#Further_Links">Further Links</a>.</li></ul></section><section> +<h2>Pull request acceptance criteria</h2> <p>There are a number of criteria that a pull request will be judged on:</p> <ul> - -<li> -<p>Whether it works and does what is intended. This one is probably obvious!</p></li> -<li> -<p>Whether it fits the spirit of the project. Some pull requests may be rejected as they take the project in a different direction than the current development community has chosen. This is usually discussed on an issue well before a pull request is contributed, so if you are unsure, discuss it there or on the mailing lists first. Feel free to continue discussing it (with new justification) if you disagree, or appeal to a wider audience on the mailing lists.</p></li> -<li> -<p>Whether it contains tests. It is expected that any pull request relating to functionality will be accompanied by unit tests and/or integration tests. It is strongly desired (and will be requested) for bug fixes too, but will not be the basis for not applying it. At a bare minimum, the change should not decrease the amount of automated test coverage. As a community, we are focusing on increasing the current coverage, as there are several areas that do not receive automated testing.</p></li> -<li> -<p>Whether it contains documentation. All new functionality needs to be documented for users, even if it is very rough for someone to expand on later. While rough is acceptable, incomplete is not. As with automated testing, as a community we are striving to increase the current coverage of documentation.</p></li> -</ul> +<li>Whether it works and does what is intended. This one is probably obvious!</li> +<li>Whether it fits the spirit of the project. Some pull requests may be rejected as they take the project in a different direction than the current development community has chosen. This is usually discussed on an issue well before a pull request is contributed, so if you are unsure, discuss it there or on the mailing lists first. Feel free to continue discussing it (with new justification) if you disagree, or appeal to a wider audience on the mailing lists.</li> +<li>Whether it contains tests. It is expected that any pull request relating to functionality will be accompanied by unit tests and/or integration tests. It is strongly desired (and will be requested) for bug fixes too, but will not be the basis for not applying it. At a bare minimum, the change should not decrease the amount of automated test coverage. As a community, we are focusing on increasing the current coverage, as there are several areas that do not receive automated testing.</li> +<li>Whether it contains documentation. All new functionality needs to be documented for users, even if it is very rough for someone to expand on later. While rough is acceptable, incomplete is not. As with automated testing, as a community we are striving to increase the current coverage of documentation.</li></ul> <p>Above all, don't be discouraged. These are the same requirements the current committers should hold each other to as well. And remember, your contributions are always welcome!</p></section><section> -<h3>Related Projects</h3> +<h2>Related Projects</h2> <p>Maven has a few dependencies on other projects:</p> <ul> - -<li> -<p><strong>Plexus</strong></p> +<li><b>Plexus</b> <p>Plexus is a full-fledged container supporting different kinds of component lifecycles. Its native lifecycle is like any other modern IoC container, using field injection of both requirements and configuration. All core Maven functionality are Plexus components.</p> -<p>You can <a href="https://codehaus-plexus.github.io/"; class="externalLink">read more about Plexus</a>.</p></li> -<li> -<p><strong>Modello</strong></p> +<p>You can <a class="externalLink" href="https://codehaus-plexus.github.io/";>read more about Plexus</a>.</p></li> +<li><b>Modello</b> <p>Modello is a simple tool for representing an object model and generating code and resources from the model. Maven uses Modello to generate all Java objects, XML readers and writers, XML Schema, and HTML documentation.</p> -<p>You can <a href="https://codehaus-plexus.github.io/modello/"; class="externalLink">read more about Modello</a>.</p></li> -<li> -<p><strong>Mojo</strong></p> -<p>“Mojo” is really two things when it comes to Maven: it is both <a href="/ref/current/maven-plugin-api/">Maven's plug-in API</a> and also <a href="http://www.mojohaus.org"; class="externalLink">a separate Mojohaus project</a> hosting a lot of plugins.</p> -<p><a href="http://www.mojohaus.org"; class="externalLink">The MojoHaus Project</a> is a plugin forge for non-core Maven plugins. There is also a lower bar for becoming a part of the project.</p></li> -</ul></section><section> -<h3>Sub Projects</h3> +<p>You can <a class="externalLink" href="https://codehaus-plexus.github.io/modello/";>read more about Modello</a>.</p></li> +<li><b>Mojo</b> +<p>"Mojo" is really two things when it comes to Maven: it is both <a href="/ref/current/maven-plugin-api/">Maven's plug-in API</a> and also <a class="externalLink" href="http://www.mojohaus.org";>a separate Mojohaus project</a> hosting a lot of plugins.</p> +<p><a class="externalLink" href="http://www.mojohaus.org";>The MojoHaus Project</a> is a plugin forge for non-core Maven plugins. There is also a lower bar for becoming a part of the project.</p></li></ul></section><section> +<h2>Sub Projects</h2> <ul> - -<li> -<p><strong>Maven Surefire</strong></p> -<p>Surefire is a testing framework. It can run regular JUnit tests so you won't have to change anything in your code to use it. It supports scripting tests in BeanShell and Jython and has special “batteries” for writing acceptance and functional tests for the web and for testing XML-RPC code.</p> +<li><b>Maven Surefire</b> +<p>Surefire is a testing framework. It can run regular JUnit tests so you won't have to change anything in your code to use it. It supports scripting tests in BeanShell and Jython and has special "batteries" for writing acceptance and functional tests for the web and for testing XML-RPC code.</p> <p>You can <a href="/surefire/">read more about Surefire</a>.</p></li> -<li> -<p><strong>Maven Doxia</strong></p> +<li><b>Maven Doxia</b> <p>Doxia is Maven's documentation engine. It has a sink and parser API that can be used to plug in support for input and output documents.</p> <p>You can read more about <a href="/doxia/">Doxia</a> and the currently supported <a href="/doxia/references/index.html">document formats</a>.</p></li> -<li> -<p><strong>Maven SCM</strong></p> +<li><b>Maven SCM</b> <p>Maven SCM (Source Control Management) is a reusable API which is independent of Maven itself. It is used by the SCM related Maven Plugins. The core part of Maven doesn't depend on Maven SCM.</p> <p>You can <a href="/scm/">read more about Scm</a>.</p></li> -<li> -<p><strong>Maven Wagon</strong></p> +<li><b>Maven Wagon</b> <p>Maven Wagon is a standalone API that dealt with transporting files and directories in Maven 2.x. Maven Core today uses the Resolver Transport API, that among other implementations, contains a wrapper for Wagon as well. Also, the site plug-in uses it to publish the site.</p> -<p>You can <a href="/wagon/">read more about Wagon</a>.</p></li> -</ul></section><section> -<h3>Further Links</h3> +<p>You can <a href="/wagon/">read more about Wagon</a>.</p></li></ul></section><section> +<h2><a id="Further_Links">Further Links</a></h2> <ul> - -<li> -<p><a href="../../developers/conventions/code.html">Maven Code Style And Code Convention</a></p></li> -<li> -<p><a href="../../developers/conventions/jira.html">Maven JIRA Convention</a></p></li> -</ul></section></section></section> +<li><a href="../../developers/conventions/code.html">Maven Code Style And Code Convention</a></li> +<li><a href="../../developers/conventions/jira.html">Maven JIRA Convention</a></li></ul></section></section> </main> </div> </div> Modified: maven/website/content/guides/development/guide-plugin-documentation.html ============================================================================== --- maven/website/content/guides/development/guide-plugin-documentation.html (original) +++ maven/website/content/guides/development/guide-plugin-documentation.html Sat Feb 18 20:40:58 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/development/guide-plugin-documentation.md at 2023-02-18 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/development/guide-plugin-documentation.apt at 2023-02-18 | Rendered using Apache Maven Fluido Skin 1.11.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang=""> @@ -48,7 +48,7 @@ <ul class="breadcrumb"> <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class="active ">Guide to the Plugin Documentation Standard <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/development/guide-plugin-documentation.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li class="active ">Guide to the Plugin Documentation Standard <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/development/guide-plugin-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: 2023-02-18</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -123,88 +123,47 @@ </div> </header> <main id="bodyColumn" class="span10" > -<!-- -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. ---> -<section><section> -<h2>Introduction</h2><section> -<h3>Where did the standard come from?</h3> -<p>The plugin documentation standard was created to address the frequent complain of lack of documentation, specifically on the Maven plugins. The standard was based on the suggestions made on the Maven dev mailing list with some refinements. It is a community consensus of what basic documentation a Maven plugin should have.</p></section><section> -<h3>Why do we need a documentation standard?</h3> +<section> +<h1>Introduction</h1><section> +<h2>Where did the standard come from?</h2> +<p>The plugin documentation standard was created to address the frequent complain of lack of documentation, specifically on the Maven plugins. The standard was based on the suggestions made on the Maven dev mailing list with some refinements. It is a community consensus of what basic documentation a Maven plugin should have. </p></section><section> +<h2>Why do we need a documentation standard?</h2> <p>The standard is not a set of rules but a guide to help plugin developers document their plugins better, for the benefit of the users of the plugin. The standard also reminds the plugin developers of the important details that needs to be documented, to help speed up the adoption of the plugin.</p></section></section><section> -<h2>Generated Documentation</h2> -<p>It is recommended that you let Maven generate the basic information for the plugin to make sure that that the basic information is always accurate and synchronized with the plugin implementation.</p> -<p>Documentation is generated by running</p> - -<div class="source"><pre class="prettyprint linenums"><code>mvn site -</code></pre></div> +<h1>Generated Documentation </h1> +<p>It is recommended that you let Maven generate the basic information for the plugin to make sure that that the basic information is always accurate and synchronized with the plugin implementation. </p> +<p>Documentation is generated by running </p> +<div> +<pre>mvn site</pre></div> <p>It will generate a plugin site based on the information in the POM, <code>src/site</code> and other reporting plugins configured in the POM. The most important reporting plugin is the <a href="/plugins/maven-plugin-plugin/">Maven Plugin Plugin</a> which will generate the documentation for each plugin goal based on the mojo annotations. But in order for the generated site to be usable, the required information should be available to the Maven Site Plugin.</p><section> -<h3>POM Elements</h3> +<h2>POM Elements</h2> <p>Maven extracts the information from the POM to generate the pages under Project Information. The first step in having a good documentation is to have an accurate and visible basic project information, Maven can provide this for the plugin as long as the information in the POM is complete, descriptive and accurate.</p><section> -<h4>Required Elements</h4> +<h3>Required Elements</h3> <p>Minimum elements for a valid POM:</p> <ul> - -<li> -<p><code><modelVersion></code> - POM model version, currently 4.0.0</p></li> -<li> -<p><code><groupId></code> - the package name</p></li> -<li> -<p><code><artifactId></code> - artifact name</p></li> -<li> -<p><code><packaging></code> - type of artifact produced by the POM</p></li> -<li> -<p><code><version></code> - the plugin version</p></li> -</ul></section><section> -<h4>Optional Elements</h4> +<li><code><modelVersion></code> - POM model version, currently 4.0.0</li> +<li><code><groupId></code> - the package name</li> +<li><code><artifactId></code> - artifact name</li> +<li><code><packaging></code> - type of artifact produced by the POM</li> +<li><code><version></code> - the plugin version</li></ul></section><section> +<h3>Optional Elements </h3> <p>These might be optional elements in a valid POM but they are important basic project information required by the users to effectively use the plugin:</p> <ul> - -<li> -<p><code><name></code> - plugin's name, <em>Maven NNN Plugin</em> for plugins hosted at the Maven project or <em>NNN Maven Plugin</em> for all others</p></li> -<li> -<p><code><description></code> - project description, an overview of what the plugin can do</p></li> -<li> -<p><code><url></code> - the site of the plugin, normally <em>maven.apache.org</em> or <em>org.mojohaus</em></p></li> -<li> -<p><code><prerequisites></code> - the minimum version of Maven required to use this plugin</p></li> -<li> -<p><code><issueManagement></code> - describes the system used for reporting problems and modification requests</p></li> -</ul> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><project> +<li><code><name></code> - plugin's name, <i>Maven NNN Plugin</i> for plugins hosted at the Maven project or <i>NNN Maven Plugin</i> for all others</li> +<li><code><description></code> - project description, an overview of what the plugin can do</li> +<li><code><url></code> - the site of the plugin, normally <i>maven.apache.org</i> or <i>org.mojohaus</i></li> +<li><code><prerequisites></code> - the minimum version of Maven required to use this plugin</li> +<li><code><issueManagement></code> - describes the system used for reporting problems and modification requests +<div class="source"><pre class="prettyprint linenums"><project> [...] <issueManagement> <system>jira</system> <url>http://jira.someproject.org</url> </issueManagement> [...] -</project> -</code></pre></div> -<ul> - -<li> -<p><code><inceptionYear></code> - year the plugin was first created</p></li> -<li> -<p><code><mailingLists></code> - lists where other users or the developers can be contacted for help and discussions</p></li> -</ul> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><project> +</project></pre></div></li> +<li><code><inceptionYear></code> - year the plugin was first created</li> +<li><code><mailingLists></code> - lists where other users or the developers can be contacted for help and discussions +<div class="source"><pre class="prettyprint linenums"><project> [...] <mailingLists> <mailingList> @@ -219,14 +178,9 @@ under the License. </mailingList> </mailingLists> [...] -</project> -</code></pre></div> -<ul> - -<li><code><licenses></code> - plugin license</li> -</ul> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><project> +</project></pre></div></li> +<li><code><licenses></code> - plugin license +<div class="source"><pre class="prettyprint linenums"><project> [...] <licenses> <license> @@ -236,14 +190,9 @@ under the License. </license> </licenses> [...] -</project> -</code></pre></div> -<ul> - -<li><code><scm></code> - the source code management configuration - a plugin without this would raise suspicion, might not be OSS</li> -</ul> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><project> +</project></pre></div></li> +<li><code><scm></code> - the source code management configuration - a plugin without this would raise suspicion, might not be OSS +<div class="source"><pre class="prettyprint linenums"><project> [...] <scm> <connection>scm:svn:http://noonecares.com/some/plugin/project/trunk</connection> @@ -251,26 +200,19 @@ under the License. <url>http://noonecares.com/viewvc/some/project/trunk/</url> </scm> [...] -</project> -</code></pre></div> -<ul> - -<li><code><organization></code> - the organization maintaining the plugin, just in case we need someone to blame</li> -</ul> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><project> +</project></pre></div></li> +<li><code><organization></code> - the organization maintaining the plugin, just in case we need someone to blame +<div class="source"><pre class="prettyprint linenums"><project> [...] <organization> <name>Noone Care Software Foundation</name> <url>http://noonecare.org/</url> </organization> [...] -</project> -</code></pre></div></section></section><section> -<h3>Plugin Configuration Parameters</h3> +</project></pre></div></li></ul></section></section><section> +<h2>Plugin Configuration Parameters</h2> <p>The Maven Plugin Plugin is responsible for generating the Plugin Info site and needs to be added to the <code><reporting></code> section unless it is already inherited from a parent POM:</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><project> +<div class="source"><pre class="prettyprint linenums"><project> [...] <reporting> <plugins> @@ -282,29 +224,20 @@ under the License. </plugins> </reporting> [...] -</project> -</code></pre></div> +</project></pre></div> <p>The comments, annotations and plugin parameter names are extracted from the plugin source and rendered in the Plugin Info page. In order for the generated site to be useful here are some guidelines you can follow when documenting your plugin.</p> <ul> - -<li>all <code>@parameter</code> fields should have a descriptive comment, informative enough that even a regular user can understand</li> -</ul> - -<div class="source"><pre class="prettyprint linenums"><code class="language-java"> [...] +<li>all <code>@parameter</code> fields should have a descriptive comment, informative enough that even a regular user can understand +<div class="source"><pre class="prettyprint linenums"> [...] /** * Put something informative here that a regular user can understand. * * @parameter */ private boolean someparameter; - [...] -</code></pre></div> -<ul> - -<li>class level comment should explain what the goal does</li> -</ul> - -<div class="source"><pre class="prettyprint linenums"><code class="language-java">[...] + [...]</pre></div></li> +<li>class level comment should explain what the goal does +<div class="source"><pre class="prettyprint linenums">[...] /** * Everything here will show up on the top of the generated plugin info page. * @@ -317,18 +250,13 @@ public class ExampleMojo public void execute() throws MojoExecutionException, MojoFailureException { -[...] -</code></pre></div> -<ul> - -<li>the <code>@component</code> and <code>@readonly</code> parameters are not required to have any comments but it's still a good practice to provide one</li> -</ul></section><section> -<h3>Site Organization</h3> -<p>Visibility of the information is also crucial, having uniform navigation links will greatly improve the visibility of the documentations. The index page can also help emphasize important sections and pages of the plugin documentation.</p><section> -<h4>Site Descriptor</h4> +[...]</pre></div></li> +<li>the <code>@component</code> and <code>@readonly</code> parameters are not required to have any comments but it's still a good practice to provide one</li></ul></section><section> +<h2>Site Organization </h2> +<p>Visibility of the information is also crucial, having uniform navigation links will greatly improve the visibility of the documentations. The index page can also help emphasize important sections and pages of the plugin documentation. </p><section> +<h3>Site Descriptor </h3> <p>The site descriptor describes the navigation links and can be found in <code>src/site/site.xml</code>. Below is the suggested site descriptor template.</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><?xml version="1.0" encoding="UTF-8"?> +<div class="source"><pre class="prettyprint linenums"><?xml version="1.0" encoding="UTF-8"?> <project> <body> <menu name="Overview"> @@ -343,17 +271,13 @@ public class ExampleMojo <item name="description2" href="examples/example-two.html"/> </menu> </body> -</project> -</code></pre></div><section> -<h5>Navigation Links</h5> +</project></pre></div><section> +<h4>Navigation Links</h4> <ul> - -<li> -<p>Introduction</p> -<p>The introduction is the front page of the plugin documentation. This is a good place to place any section and pages that needs to be emphasized. It is also suggested that the generated plugin parameter configuration be linked here. Below is the suggested <code>src/site/apt/index.apt</code> template</p></li> -</ul> - -<div class="source"><pre class="prettyprint linenums"><code> ------ +<li>Introduction +<p>The introduction is the front page of the plugin documentation. This is a good place to place any section and pages that needs to be emphasized. It is also suggested that the generated plugin parameter configuration be linked here. Below is the suggested <code>src/site/apt/index.apt</code> template</p> +<div> +<pre> ------ Introduction ------ Author @@ -400,22 +324,14 @@ Plugin Name * {{{./examples/example-one.html}Example Description One}} * {{{./examples/example-two.html}Example Description Two}} - -</code></pre></div> -<ul> - -<li> -<p>Goals</p> -<p><code>plugin-info.html</code> is generated by the Maven Plugin Plugin. Until the Maven Site Plugin is updated it would be better to pull it out to the main menu for greater visibility. This contains the goals and their descriptions with a link to the configuration parameters. The information is based on the comments and annotations of the plugin.</p></li> -<li> -<p>Usage (this was previously called Howto)</p> -<p>The usage page describes the the basic use cases for the plugin goals which includes sample POM configurations and explanation of how the goals work.</p></li> -<li> -<p>FAQ</p> -<p>A well documented project always collates frequently asked questions which are usually located in <code>src/site/fml/faq.fml</code>. The example below provides a template for your FAQ:</p></li> -</ul> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><?xml version="1.0" encoding="UTF-8"?> + </pre></div></li> +<li>Goals +<p><code>plugin-info.html</code> is generated by the Maven Plugin Plugin. Until the Maven Site Plugin is updated it would be better to pull it out to the main menu for greater visibility. This contains the goals and their descriptions with a link to the configuration parameters. The information is based on the comments and annotations of the plugin. </p></li> +<li>Usage (this was previously called Howto) +<p>The usage page describes the the basic use cases for the plugin goals which includes sample POM configurations and explanation of how the goals work. </p></li> +<li>FAQ +<p>A well documented project always collates frequently asked questions which are usually located in <code>src/site/fml/faq.fml</code>. The example below provides a template for your FAQ:</p> +<div class="source"><pre class="prettyprint linenums"><?xml version="1.0" encoding="UTF-8"?> <faqs id="FAQ" title="Frequently Asked Questions"> <part id="General"> <faq id="question"> @@ -427,30 +343,20 @@ Plugin Name </answer> </faq> </part> -</faqs> -</code></pre></div> -<ul> - -<li> -<p>Examples</p> +</faqs></pre></div></li> +<li>Examples <p>The advanced configurations and examples not covered in the usage page is located here. Advanced users who wants to maximize the use of a plugin can check the items here. Tips on how to use the plugin effectively is also a good thing to put here.</p> -<p>For examples of items under “Examples” check these plugin sites:</p></li> -<li> -<p><a href="/plugins/maven-javadoc-plugin/">Maven Javadoc Plugin Examples</a></p></li> -<li> -<p><a href="/plugins/maven-war-plugin/">Maven War Plugin Examples</a></p></li> -</ul></section></section></section><section> -<h3>Recommended Configured Reports</h3> +<p>For examples of items under "Examples" check these plugin sites:</p> +<ul> +<li><a href="/plugins/maven-javadoc-plugin/">Maven Javadoc Plugin Examples</a></li> +<li><a href="/plugins/maven-war-plugin/">Maven War Plugin Examples</a></li></ul></li></ul></section></section></section><section> +<h2>Recommended Configured Reports</h2> <p>There are 2 recommended report plugins to enhance the plugin documentation, Javadoc and JXR.</p> <ul> - -<li> -<p>Maven Javadoc Plugin</p> +<li>Maven Javadoc Plugin <p>Javadocs provide documentation that makes it easier for developers to know how to use a particular class. Instead of reading and understanding the actual source code, the developer can use the Javadocs instead to lookup the class attributes and methods.</p> -<p>To enable javadoc for your plugin add the following to your <code>pom.xml</code></p></li> -</ul> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><project> +<p>To enable javadoc for your plugin add the following to your <code>pom.xml</code></p> +<div class="source"><pre class="prettyprint linenums"><project> [...] <build> [...] @@ -471,18 +377,12 @@ Plugin Name [...] </reporting> [...] -</project> -</code></pre></div> -<p>Check the documentation about the plugin's <a href="/plugins/maven-javadoc-plugin/javadoc-mojo.html"><code>javadoc:javadoc</code></a> goal for the advanced configurations.</p> -<ul> - -<li> -<p>Maven JXR Plugin</p> +</project></pre></div> +<p>Check the documentation about the plugin's <a href="/plugins/maven-javadoc-plugin/javadoc-mojo.html"><code>javadoc:javadoc</code></a> goal for the advanced configurations.</p></li> +<li>Maven JXR Plugin <p>The Maven JXR Plugin generates a cross-reference of the project sources. The generated cross-references are also linked to the corresponding javadoc if javadoc is generated. The cross-references is great for those who wants to better understand the inner workings of the plugin.</p> -<p>To enable source code cross-references add the following to your <code>pom.xml</code></p></li> -</ul> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><project> +<p>To enable source code cross-references add the following to your <code>pom.xml</code></p> +<div class="source"><pre class="prettyprint linenums"><project> [...] <build> [...] @@ -497,9 +397,8 @@ Plugin Name </plugins> </reporting> [...] -</project> -</code></pre></div> -<p>Check the <a href="/plugins/maven-jxr-plugin/jxr-mojo.html">JXR configuration page</a> for the possible configuration parameters.</p></section></section></section> +</project></pre></div> +<p>Check the <a href="/plugins/maven-jxr-plugin/jxr-mojo.html">JXR configuration page</a> for the possible configuration parameters.</p></li></ul></section></section> </main> </div> </div> Modified: maven/website/content/guides/development/guide-testing-development-plugins.html ============================================================================== --- maven/website/content/guides/development/guide-testing-development-plugins.html (original) +++ maven/website/content/guides/development/guide-testing-development-plugins.html Sat Feb 18 20:40:58 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/development/guide-testing-development-plugins.md at 2023-02-18 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/development/guide-testing-development-plugins.apt at 2023-02-18 | Rendered using Apache Maven Fluido Skin 1.11.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang=""> @@ -48,7 +48,7 @@ <ul class="breadcrumb"> <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class="active ">Guide to Testing Development Versions of Plugins <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/development/guide-testing-development-plugins.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li class="active ">Guide to Testing Development Versions of Plugins <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/development/guide-testing-development-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: 2023-02-18</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -139,37 +139,18 @@ </div> </header> <main id="bodyColumn" class="span10" > -<!-- -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. ---> -<section><section> -<h2>Guide to Testing Development Versions of Plugins</h2><section> -<h3>Why would I want to do this?</h3> +<section> +<h1>Guide to Testing Development Versions of Plugins</h1><section> +<h2>Why would I want to do this?</h2> <p>If a bug you are encountering has been reported as fixed but not yet released, you can confirm that it has been fixed for you. Or perhaps you just like to live on the bleeding edge.</p> <p>You are highly encouraged to join the development list for the project and provide your feedback, or help promote release of the plugin in question.</p> -<p><em>Note:</em> This is <strong>not</strong> recommended as an everyday or in production practice! Snapshots are for testing purposes only and are not official releases. For more information, see <a href="http://www.apache.org/dev/release.html#what"; class="externalLink">the Releases FAQ</a>.</p></section><section> -<h3>How do I do this?</h3> -<p>Development versions of Maven plugins are periodically published to the repository: <a href="https://repository.apache.org/snapshots/"; class="externalLink">https://repository.apache.org/snapshots/</a>.</p> -<p><em>Note:</em> Currently, this is not done automatically by our continuous integration setup. This is coming soon.</p> -<p>Other sites may publish there own - for example, the MojoHaus project hosts theirs at <a href="https://oss.sonatype.org/content/repositories/snapshots/"; class="externalLink">https://oss.sonatype.org/content/repositories/snapshots/</a></p> +<p><i>Note:</i> This is <b>not</b> recommended as an everyday or in production practice! Snapshots are for testing purposes only and are not official releases. For more information, see <a class="externalLink" href="http://www.apache.org/dev/release.html#what";> the Releases FAQ</a>.</p></section><section> +<h2>How do I do this?</h2> +<p>Development versions of Maven plugins are periodically published to the repository: <a class="externalLink" href="https://repository.apache.org/snapshots/";>https://repository.apache.org/snapshots/</a>.</p> +<p><i>Note:</i> Currently, this is not done automatically by our continuous integration setup. This is coming soon.</p> +<p>Other sites may publish there own - for example, the MojoHaus project hosts theirs at <a class="externalLink" href="https://oss.sonatype.org/content/repositories/snapshots/";>https://oss.sonatype.org/content/repositories/snapshots/</a></p> <p>The first step is to include this in your project:</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><project> +<div class="source"><pre class="prettyprint linenums"><project> ... <pluginRepositories> <pluginRepository> @@ -178,20 +159,13 @@ under the License. </pluginRepository> </pluginRepositories> ... -</project> -</code></pre></div> +</project></pre></div> <p>After this is included, there are three ways to use the updated versions:</p> <ul> - -<li> -<p>Set the appropriate version in the plugin, eg <code>2.0.1-SNAPSHOT</code></p></li> -<li> -<p>If you have not specified a version, use the <code>-U</code> switch to update plugins for the given Maven run</p></li> -<li> -<p>You can have Maven automatically check for updates on a given interval, for example:</p></li> -</ul> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><project> +<li>Set the appropriate version in the plugin, eg <code>2.0.1-SNAPSHOT</code></li> +<li>If you have not specified a version, use the <code>-U</code> switch to update plugins for the given Maven run</li> +<li>You can have Maven automatically check for updates on a given interval, for example: +<div class="source"><pre class="prettyprint linenums"><project> ... <pluginRepositories> <pluginRepository> @@ -200,15 +174,13 @@ under the License. </pluginRepository> </pluginRepositories> ... -</project> -</code></pre></div> -<p><em>Note:</em> These last two techniques mean that <em>every</em> plugin will be updated to the latest snapshot version.</p> +</project></pre></div></li></ul> +<p><i>Note:</i> These last two techniques mean that <i>every</i> plugin will be updated to the latest snapshot version.</p> <p>The development version will stop being used if the <code><pluginRepository></code> element is removed from your POM and the version is set back to the release version. If you are using the command line or an unspecified version, you will also need to remove the version from the local repository.</p></section><section> -<h3>Using Settings without Modifying the Project</h3> +<h2>Using Settings without Modifying the Project</h2> <p>If you are using the goals from the command line on a number of projects, you should include this in your <code>settings.xml</code> file instead.</p> <p>You need to modify your <code>${user.home}/.m2/settings.xml</code> file to include two new profiles and then when you need access to the plugin snapshots use <code>-Papache</code>. The profile only needs to be enabled once so that the plugins can be downloaded into you local repository. Once in your local repository Maven can successfully resolve the dependencies and the profile no longer needs to be activated.</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><settings> +<div class="source"><pre class="prettyprint linenums"><settings> ... <profiles> <profile> @@ -229,16 +201,14 @@ under the License. </profile> </profiles> ... -</settings> -</code></pre></div> +</settings></pre></div> <p>When invoking Maven for Apache profile, do it like this:</p> - -<div class="source"><pre class="prettyprint linenums"><code>mvn -Papache <phase|goal> -</code></pre></div></section><section> -<h3>Using a Repository Manager</h3> -<p>In addition to the above you may want to use a repository manager so that you can retain the builds you have been using. For information on this technique, see the <a href="./guide-testing-releases.html">Guide to Testing Staged Releases</a>.</p></section><section> -<h3>How do I make changes to the source and test development versions of the plugins?</h3> -<p>For information on this, see the <a href="./guide-maven-development.html">Guide to Maven Development</a>.</p></section></section></section> +<div> +<pre>mvn -Papache <phase|goal></pre></div></section><section> +<h2>Using a Repository Manager</h2> +<p>In addition to the above you may want to use a repository manager so that you can retain the builds you have been using. For information on this technique, see the <a href="./guide-testing-releases.html"> Guide to Testing Staged Releases</a>.</p></section><section> +<h2>How do I make changes to the source and test development versions of the plugins?</h2> +<p>For information on this, see the <a href="./guide-maven-development.html">Guide to Maven Development</a>.</p></section></section> </main> </div> </div> Modified: maven/website/content/guides/development/guide-testing-releases.html ============================================================================== --- maven/website/content/guides/development/guide-testing-releases.html (original) +++ maven/website/content/guides/development/guide-testing-releases.html Sat Feb 18 20:40:58 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/development/guide-testing-releases.md at 2023-02-18 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/development/guide-testing-releases.apt at 2023-02-18 | Rendered using Apache Maven Fluido Skin 1.11.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang=""> @@ -48,7 +48,7 @@ <ul class="breadcrumb"> <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class="active ">Guide to Testing Staged Releases <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/development/guide-testing-releases.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li class="active ">Guide to Testing Staged Releases <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/development/guide-testing-releases.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-18</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -139,108 +139,60 @@ </div> </header> <main id="bodyColumn" class="span10" > -<!-- -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. ---> -<section><section> -<h2>Guide to Testing Staged Releases</h2> +<section> +<h1>Guide to Testing Staged Releases</h1> <p>As part of the release process, the artifacts are staged in a temporary repository for testing and evaluation before voting. Such repositories are not available by default, so to use them your project must be configured appropriately.</p> <p>The steps are as follows:</p> <ul> - -<li> -<p>add the repository or plugin repository to your POM or settings (see below)</p></li> -<li> -<p>ensure you are using the version being released of the artifacts in your project, e.g. by setting the <code><version></code> in the <code><plugin></code> tag.</p></li> -<li> -<p>test the release</p></li> -<li> -<p>remove the repository from your POM if it was specified there</p></li> -<li> -<p>remove the artifacts from your local repository when you have completed testing</p></li> -</ul> +<li>add the repository or plugin repository to your POM or settings (see below)</li> +<li>ensure you are using the version being released of the artifacts in your project, e.g. by setting the <code><version></code> in the <code><plugin></code> tag.</li> +<li>test the release</li> +<li>remove the repository from your POM if it was specified there</li> +<li>remove the artifacts from your local repository when you have completed testing</li></ul> <p>The repository configuration for testing a plugin will typically look something like this (it will be provided in the vote email):</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> ... +<div class="source"><pre class="prettyprint linenums"> ... <pluginRepositories> <pluginRepository> <id>staged-releases</id> <url>https://repository.apache.org/content/groups/staging/</url> </pluginRepository> </pluginRepositories> - ... -</code></pre></div> + ...</pre></div> <p>The important thing is that the staged release does not pollute your eventual environment as it may change if the vote fails and the release is made again. This is why clearing the local repository is necessary, but if you are using a repository manager this is also important to clear. The following provides instructions for setting Archiva up in such a way that the artifacts are isolated already.</p><section> -<h3>Setting up Archiva to Test Staged Releases</h3> +<h2>Setting up Archiva to Test Staged Releases</h2> <p>These steps will be similar for any repository manager - please refer to their individual documentation for instructions on how to configure remote proxies.</p> <p>For Archiva, the first step is to create a new managed repository for the staged releases. This will ensure they remain isolated from your environment. On the repositories tab, add a new managed repository with the settings:</p> <ul> - -<li> -<p>Identifier = <code>staged-releases</code></p></li> -<li> -<p>Name = Staged Releases</p></li> -<li> -<p>Directory = <code>/path/to/repositories/staged-releases</code></p></li> -<li> -<p>Uncheck ‘Scannable’</p></li> -</ul> +<li>Identifier = <code>staged-releases</code></li> +<li>Name = Staged Releases</li> +<li>Directory = <code>/path/to/repositories/staged-releases</code></li> +<li>Uncheck 'Scannable'</li></ul> <p>Next add a remote repository with settings similar to the following:</p> <ul> - -<li> -<p>Identifier = <code>dfabulich.staged.releases</code></p></li> -<li> -<p>Name = dfabulich Staged Releases</p></li> -<li> -<p>URL = <code>http://people.apache.org/\~dfabulich/staging-repo/</code></p></li> -</ul> +<li>Identifier = <code>dfabulich.staged.releases</code></li> +<li>Name = dfabulich Staged Releases</li> +<li>URL = <code>http://people.apache.org/~dfabulich/staging-repo/</code></li></ul> <p>Finally, add a proxy connector to connect the two repositories:</p> <ul> - -<li> -<p>Managed repository = <code>staged-releases</code></p></li> -<li> -<p>Remote repository = <code>dfabulich.staged</code></p></li> -<li> -<p>Release policy = <code>once</code></p></li> -<li> -<p>Snapshot policy = <code>never</code></p></li> -<li> -<p>White list = <code>org/apache/maven/\*\*</code></p></li> -</ul> +<li>Managed repository = <code>staged-releases</code></li> +<li>Remote repository = <code>dfabulich.staged</code></li> +<li>Release policy = <code>once</code></li> +<li>Snapshot policy = <code>never</code></li> +<li>White list = <code>org/apache/maven/**</code></li></ul> <p>You can then utilise this repository from your POM or settings in the same way, but with the alternate URL of <code>http://localhost:8080/archiva/repository/staged-releases/</code>.</p> <p>The advantage of this approach is that you can usually remove your entire local repository afterwards and after removing the staged repository from your POM the artifacts will no longer be used. There is no need to remove the repository or artifacts from Archiva itself - unless a staged release is updated for further testing.</p> <p>It is also quite easy to test another staged release at a later date by reusing the repository, or adding a proxy connector and remote repository for a different staging repository.</p> <p>If you are using the repository mirroring technique to lock down to the repository manager in your environment, you would add an additional mirror to correspond to the additional repository in the POM, such as:</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> ... +<div class="source"><pre class="prettyprint linenums"> ... <mirror> <id>staged-releases-mirror</id> <url>http://localhost:8080/archiva/repository/staged-releases/</url> <mirrorOf>staged-releases</mirrorOf> </mirror> - ... -</code></pre></div></section><section> -<h3>Using a Settings Profile</h3> -<p>If you regularly test staged releases and want to have a more convenient way to add the repository to a build without modifying your POM, you may add a profile to your <code>\~/.m2/settings.xml</code>:</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> ... + ...</pre></div></section><section> +<h2>Using a Settings Profile</h2> +<p>If you regularly test staged releases and want to have a more convenient way to add the repository to a build without modifying your POM, you may add a profile to your <code>~/.m2/settings.xml</code>:</p> +<div class="source"><pre class="prettyprint linenums"> ... <profiles> <profile> <id>staged-releases</id> @@ -251,13 +203,11 @@ under the License. </pluginRepository> </pluginRepositories> </profile> - ... -</code></pre></div> + ...</pre></div> <p>With this in place, you can activate it by simply changing the plugin version to the one you are testing in the POM as above, then run the build with the following command:</p> - -<div class="source"><pre class="prettyprint linenums"><code>mvn verify -Pstaged-releases -</code></pre></div> -<p>Note that the same conditions apply as above about cleaning out the local repository to prevent pollution of your local build environment.</p></section></section></section> +<div> +<pre>mvn verify -Pstaged-releases</pre></div> +<p>Note that the same conditions apply as above about cleaning out the local repository to prevent pollution of your local build environment.</p></section></section> </main> </div> </div>
