This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-release-plugin.git
The following commit(s) were added to refs/heads/master by this push: new bc8331a Preparations for releasing 1.8.0. bc8331a is described below commit bc8331a737a34479fe7238ca6bc6d6b76eebb5e3 Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Sat Mar 12 16:13:01 2022 -0500 Preparations for releasing 1.8.0. --- CONTRIBUTING.md | 50 +++-- NOTICE.txt | 4 +- README.md | 39 ++-- RELEASE-NOTES.txt | 68 ++++++ pom.xml | 8 +- src/changes/changes.xml | 2 +- src/changes/release-notes.vm | 108 ++++----- src/site/xdoc/download_commons-release-plugin.xml | 254 +++++++++++----------- src/site/xdoc/issue-tracking.xml | 102 +++++++++ src/site/xdoc/mail-lists.xml | 215 ++++++++++++++++++ 10 files changed, 632 insertions(+), 218 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md old mode 100755 new mode 100644 index 2e2b962..ea9a445 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,10 +22,10 @@ |**** ****| +======================================================================+ | TEMPLATE FILE: contributing-md-template.md | - | commons-release-plugin/trunk/src/main/resources/commons-xdoc-templates | + | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates | +======================================================================+ | | - | 1) Re-generate using: mvn commons:contributing-md | + | 1) Re-generate using: mvn commons-build:contributing-md | | | | 2) Set the following properties in the component's pom: | | - commons.jira.id (required, alphabetic, upper case) | @@ -38,7 +38,7 @@ | | +======================================================================+ ---> -Contributing to Apache Commons Release Plugin Maven Mojo +Contributing to Apache Commons Release Plugin ====================== You have found a bug or you have an idea for a cool new feature? Contributing code is a great way to give something back to @@ -50,48 +50,66 @@ Getting Started + Make sure you have a [JIRA account](https://issues.apache.org/jira/). + Make sure you have a [GitHub account](https://github.com/signup/free). -+ If you're planning to implement a new feature it makes sense to discuss your changes on the [dev list](https://commons.apache.org/mail-lists.html) first. This way you can make sure you're not wasting your time on something that isn't considered to be in Apache Commons Release Plugin Maven Mojo's scope. -+ Submit a ticket for your issue, assuming one does not already exist. ++ If you're planning to implement a new feature it makes sense to discuss your changes on the [dev list](https://commons.apache.org/mail-lists.html) first. This way you can make sure you're not wasting your time on something that isn't considered to be in Apache Commons Release Plugin's scope. ++ Submit a [Jira Ticket][jira] for your issue, assuming one does not already exist. + Clearly describe the issue including steps to reproduce when it is a bug. + Make sure you fill in the earliest version that you know has the issue. -+ Fork the repository on GitHub. ++ Find the corresponding [repository on GitHub](https://github.com/apache/?query=commons-), +[fork](https://help.github.com/articles/fork-a-repo/) and check out your forked repository. Making Changes -------------- -+ Create a topic branch from where you want to base your work (this is usually the master/trunk branch). ++ Create a _topic branch_ for your isolated work. + * Usually you should base your branch on the `master` or `trunk` branch. + * A good topic branch name can be the JIRA bug id plus a keyword, e.g. `COMMONSSITE-123-InputStream`. + * If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests. + Make commits of logical units. + * Make sure your commit messages are meaningful and in the proper format. Your commit message should contain the key of the JIRA issue. + * e.g. `COMMONSSITE-123: Close input stream earlier` + Respect the original code style: + Only use spaces for indentation. - + Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change. - + Check for unnecessary whitespace with git diff --check before committing. -+ Make sure your commit messages are in the proper format. Your commit message should contain the key of the JIRA issue. -+ Make sure you have added the necessary tests for your changes. + + Create minimal diffs - disable _On Save_ actions like _Reformat Source Code_ or _Organize Imports_. If you feel the source code should be reformatted create a separate PR for this change first. + + Check for unnecessary whitespace with `git diff` -- check before committing. ++ Make sure you have added the necessary tests for your changes, typically in `src/test/java`. + Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken. Making Trivial Changes ---------------------- +The JIRA tickets are used to generate the changelog for the next release. + For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA. In this case, it is appropriate to start the first line of a commit with '(doc)' instead of a ticket number. + Submitting Changes ------------------ -+ Sign the [Contributor License Agreement][cla] if you haven't already. ++ Sign and submit the Apache [Contributor License Agreement][cla] if you haven't already. + * Note that small patches & typical bug fixes do not require a CLA as + clause 5 of the [Apache License](https://www.apache.org/licenses/LICENSE-2.0.html#contributions) + covers them. + Push your changes to a topic branch in your fork of the repository. -+ Submit a pull request to the repository in the apache organization. ++ Submit a _Pull Request_ to the corresponding repository in the `apache` organization. + * Verify _Files Changed_ shows only your intended changes and does not + include additional files like `target/*.class` + Update your JIRA ticket and include a link to the pull request in the ticket. +If you prefer to not use GitHub, then you can instead use +`git format-patch` (or `svn diff`) and attach the patch file to the JIRA issue. + + Additional Resources -------------------- + [Contributing patches](https://commons.apache.org/patches.html) -+ [Apache Commons Release Plugin Maven Mojo JIRA project page](https://issues.apache.org/jira/browse/COMMONSSITE) ++ [Apache Commons Release Plugin JIRA project page][jira] + [Contributor License Agreement][cla] + [General GitHub documentation](https://help.github.com/) -+ [GitHub pull request documentation](https://help.github.com/send-pull-requests/) ++ [GitHub pull request documentation](https://help.github.com/articles/creating-a-pull-request/) + [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) -+ #apachecommons IRC channel on freenode.org ++ `#apache-commons` IRC channel on `irc.freenode.net` [cla]:https://www.apache.org/licenses/#clas +[jira]:https://issues.apache.org/jira/browse/COMMONSSITE diff --git a/NOTICE.txt b/NOTICE.txt old mode 100755 new mode 100644 index 4357b56..f2f5a6d --- a/NOTICE.txt +++ b/NOTICE.txt @@ -1,5 +1,5 @@ Apache Commons Release Plugin -Copyright 2017-2022 The Apache Software Foundation +Copyright 2018-2022 The Apache Software Foundation This product includes software developed at -The Apache Software Foundation (http://www.apache.org/). +The Apache Software Foundation (https://www.apache.org/). diff --git a/README.md b/README.md old mode 100755 new mode 100644 index 2cdfd8c..7a18d1f --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ <!--- +======================================================================+ |**** ****| - |**** THIS FILE IS GENERATED BY THE COMMONS Release PLUGIN ****| + |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****| |**** DO NOT EDIT DIRECTLY ****| |**** ****| +======================================================================+ @@ -25,7 +25,7 @@ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates | +======================================================================+ | | - | 1) Re-generate using: mvn commons:readme-md | + | 1) Re-generate using: mvn commons-build:readme-md | | | | 2) Set the following properties in the component's pom: | | - commons.componentid (required, alphabetic, lower case) | @@ -40,25 +40,27 @@ | | +======================================================================+ ---> -Apache Commons Release Plugin. +Apache Commons Release Plugin =================== -Apache Maven Plugin for Apache Commons Release tasks. +[](https://travis-ci.org/apache/commons-commons-release-plugin) +[](https://github.com/apache/commons-commons-release-plugin/actions) +[](https://coveralls.io/r/apache/commons-commons-release-plugin) +[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-release-plugin/) +[](https://javadoc.io/doc/org.apache.commons/commons-release-plugin/1.8.0) + +Apache Maven Mojo for Apache Commons Release tasks. Documentation ------------- -More information can be found on the [homepage](https://commons.apache.org/proper/commons-release-plugin). -The [Javadoc](https://commons.apache.org/proper/commons-release-plugin/javadocs/api-release) can be browsed. +More information can be found on the [Apache Commons Release Plugin homepage](https://commons.apache.org/proper/commons-commons-release-plugin). +The [Javadoc](https://commons.apache.org/proper/commons-commons-release-plugin/apidocs) can be browsed. Questions related to the usage of Apache Commons Release Plugin should be posted to the [user mailing list][ml]. -[](https://travis-ci.org/apache/commons-release-plugin) -[](https://coveralls.io/github/apache/commons-release-plugin?branch=master) -[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-release-plugin) - Where can I get the latest release? ----------------------------------- -You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-release-plugin/download_commons-release-plugin.cgi). +You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-commons-release-plugin/download_commons-release-plugin.cgi). Alternatively you can pull it from the central Maven repositories: @@ -66,14 +68,14 @@ Alternatively you can pull it from the central Maven repositories: <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-release-plugin</artifactId> - <version>1.7</version> + <version>1.8.0</version> </dependency> ``` Contributing ------------ -We accept PRs via github. The [developer mailing list][ml] is the main channel of communication for contributors. +We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors. There are some guidelines which will make applying PRs easier for us: + No tabs! Please use spaces for indentation. + Respect the code style. @@ -85,19 +87,20 @@ You can learn more about contributing via GitHub in our [contribution guidelines License ------- -Code is under the [Apache License v2](https://www.apache.org/licenses/LICENSE-2.0.txt). +This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0). + +See the `NOTICE.txt` file for required notices and attributions. Donations --------- -You like Apache Commons Release Plugin Maven Mojo? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development. +You like Apache Commons Release Plugin? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development. Additional Resources -------------------- + [Apache Commons Homepage](https://commons.apache.org/) -+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/) ++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/COMMONSSITE) + [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) -+ #apachecommons IRC channel on freenode.org ++ `#apache-commons` IRC channel on `irc.freenode.org` [ml]:https://commons.apache.org/mail-lists.html - diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt index d37a18a..f432d57 100644 --- a/RELEASE-NOTES.txt +++ b/RELEASE-NOTES.txt @@ -1,3 +1,71 @@ +Apache Commons Release Plugin +Version 1.8.0 +Release Notes + + +INTRODUCTION: + +This document contains the release notes for the 1.8.0 version of Apache Commons Text. +Commons Text is a set of utility functions and reusable components for the purpose of processing +and manipulating text that should be of use in a Java environment. + + +Apache Maven Mojo for Apache Commons Release tasks. + +Version 1.8 + +Changes in this version include: + +New features: +o COMMONSSITE-138: Create signature validation script for releases. + +Fixed Bugs: +o Fail if commons.nexus.repo.id is not defined. +o Allow for old-style group ids in vote-txt. +o Don't create hash for .asc files. +o Replace construction of FileInputStream and FileOutputStream objects with Files NIO APIs. #44. Thanks to Arturo Bernal, Bruno P. Kinoshita. +o Replace FindBugs with SpotBugs. +o Minor Improvements #34. Thanks to Arturo Bernal. + +Changes: +o Bump maven-checkstyle-plugin from 3.1.1 to 3.1.2 #36. +o Bump maven-pmd-plugin from 3.13.0 to 3.15.0 #29 #72. +o Bump commons-build-plugin from 1.11 to 1.12 #25. +o Bump actions/setup-java from v1.4.0 to v2 #11 #19 #49. +o Bump spotbugs from 4.1.1 to 4.6.0 #10 #24 #30 #37 #41 #51 #59 #68 #71 #80 #93 #98. Thanks to Gary Gregory. +o Bump spotbugs-maven-plugin from 4.1.1 to 4.5.3.0 #20 #26 #33 #45 #52 #61 #74 #79 #81 #88 #94 #99. +o Update JUnit from 4.12 to 4.13.2, #23 #39. +o Bump maven.dependency.version from 3.6.1 to 3.8.4 #47 #76 #86. Thanks to Gary Gregory, Dependabot. +o Update commons-io:commons-io from 2.6 to 2.11.0 #13 #63. +o Update checkstyle from 8.34 to 9.3 #5, #12, #14, #27, #31, #35, #40, #46, #53, #58, #64, #65, #69, #77, #84, #91, #95, #101. +o Update actions/checkout from v2.3.1 to v3 #8, #16, #28, #78, #83, #103. +o Update velocity-engine-core from 2.1 to 2.3 #4 #43. +o Update commons-codec from 1.13 to 1.15. +o Bump actions/cache from v2 to v2.1.7 #38, #50, #56, #87. Thanks to Dependabot. +o Bump maven.plugin.version from 3.6.0 to 3.6.4 #54, #89, #97. Thanks to Dependabot. +o Bump jacoco-maven-plugin from 0.8.5 to 0.8.7 (Fixes Java 15 builds) #55. Thanks to Gary Gregory, Dependabot. +o Bump plexus-velocity from 1.2 to 1.3 #60. Thanks to Dependabot. +o Bump commons-compress from 1.19 to 1.21 #62. Thanks to Gary Gregory, Dependabot. +o Replace JUnit from 4.13.2 to 5.7.2 vintage. Thanks to Gary Gregory. +o Bump maven-scm.version from 1.11.2 to 1.12.2 #66, #73, #96. Thanks to Dependabot. +o Bump junit-vintage-engine from 5.7.2 to 5.8.2 #70, #75, #90. Thanks to Dependabot. +o Bump taglist-maven-plugin from 2.4 to 3.0.0 #100. Thanks to Dependabot. + + +Historical list of changes: https://commons.apache.org/proper/commons-release-plugin//changes-report.html + +For complete information on Apache Commons Release Plugin, including instructions on how to submit bug reports, +patches, or suggestions for improvement, see the Apache Apache Commons Release Plugin website: + +https://commons.apache.org/proper/commons-release-plugin/ + +Download page: https://commons.apache.org/proper/commons-release-plugin//download_text.cgi + +Have fun! +-Apache Commons Team + +============================================================================= + Apache Commons Release Plugin Version 1.7 Release Notes diff --git a/pom.xml b/pom.xml index 08988fb..61effef 100644 --- a/pom.xml +++ b/pom.xml @@ -25,7 +25,7 @@ </parent> <artifactId>commons-release-plugin</artifactId> <packaging>maven-plugin</packaging> - <version>1.8-SNAPSHOT</version> + <version>1.8.0-SNAPSHOT</version> <name>Apache Commons Release Plugin</name> <description> @@ -131,11 +131,11 @@ <!-- Including commons release plugin older version --> <commons.release.isDistModule>true</commons.release.isDistModule> <commons.bc.version>1.7</commons.bc.version> - <commons.release.version>1.8</commons.release.version> + <commons.release.version>1.8.0</commons.release.version> <commons.rc.version>RC1</commons.rc.version> <commons.release.isDistModule>true</commons.release.isDistModule> - <commons.releaseManagerName>Rob Tompkins</commons.releaseManagerName> - <commons.releaseManagerKey>B6E73D84EA4FCC47166087253FAAD2CD5ECBB314</commons.releaseManagerKey> + <commons.releaseManagerName>Gary Gregory</commons.releaseManagerName> + <commons.releaseManagerKey>86fdc7e2a11262cb</commons.releaseManagerKey> <maven.plugin.version>3.6.4</maven.plugin.version> </properties> diff --git a/src/changes/changes.xml b/src/changes/changes.xml index 5157c9c..e89af93 100755 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -25,7 +25,7 @@ </properties> <body> - <release version="1.8" date="2020-MM-DD" description="Version 1.8"> + <release version="1.8.0" date="2020-MM-DD" description="Version 1.8"> <action issue="COMMONSSITE-138" type="add" dev="chtompki, ggregory">Create signature validation script for releases.</action> <!-- FIXES --> <action type="fix" dev="sebb">Fail if commons.nexus.repo.id is not defined.</action> diff --git a/src/changes/release-notes.vm b/src/changes/release-notes.vm index deba478..83225f0 100755 --- a/src/changes/release-notes.vm +++ b/src/changes/release-notes.vm @@ -39,9 +39,10 @@ Release Notes INTRODUCTION: -This document contains the release notes for the ${version} version of Apache commons-release-plgin. -The commons-release-plugin is meant to be a mechanism for automating The Apache Commons Project's -release process. +This document contains the release notes for the ${version} version of Apache Commons Text. +Commons Text is a set of utility functions and reusable components for the purpose of processing +and manipulating text that should be of use in a Java environment. + $introduction.replaceAll("(?<!\015)\012", " ").replaceAll("(?m)^ +","") @@ -66,28 +67,28 @@ $release.description.replaceAll(" ", " ## #macro ( processaction ) ## Use replaceAll to fix up LF-only line ends on Windows. - #set($action=$actionItem.getAction().replaceAll("\n"," +#set($action=$actionItem.getAction().replaceAll("\n"," ")) ## Fix up indentation for multi-line action descriptions - #set($action=$action.replaceAll("(?m)^ +",$indent2)) - #if ($actionItem.getIssue()) - #set($issue="$actionItem.getIssue():") - ## Pad shorter issue numbers - #if ($issue.length() < $indent1.length())#set ($issue="$issue ")#end - #if ($issue.length() < $indent1.length())#set ($issue="$issue ")#end - #if ($issue.length() < $indent1.length())#set ($issue="$issue ")#end - #else - #set($issue=$indent1) - #end - #if ($actionItem.getDueTo()) - #set($dueto=" Thanks to $actionItem.getDueTo().") - #else - #set($dueto="") - #end +#set($action=$action.replaceAll("(?m)^ +",$indent2)) +#if ($actionItem.getIssue()) +#set($issue="$actionItem.getIssue():") +## Pad shorter issue numbers +#if ($issue.length() < $indent1.length())#set ($issue="$issue ")#end +#if ($issue.length() < $indent1.length())#set ($issue="$issue ")#end +#if ($issue.length() < $indent1.length())#set ($issue="$issue ")#end +#else +#set($issue=$indent1) +#end +#if ($actionItem.getDueTo()) +#set($dueto=" Thanks to $actionItem.getDueTo().") +#else +#set($dueto="") +#end o $issue ${action}$dueto - #set($action="") - #set($issue="") - #set($dueto="") +#set($action="") +#set($issue="") +#set($dueto="") #end ## #if ($release.getActions().size() == 0) @@ -95,39 +96,44 @@ No changes defined in this version. #else Changes in this version include: - #if ($release.getActions('add').size() !=0) - New features: - #foreach($actionItem in $release.getActions('add')) - #processaction() - #end - #end - - #if ($release.getActions('fix').size() !=0) - Fixed Bugs: - #foreach($actionItem in $release.getActions('fix')) - #processaction() - #end - #end - - #if ($release.getActions('update').size() !=0) - Changes: - #foreach($actionItem in $release.getActions('update')) - #processaction() - #end - #end - - #if ($release.getActions('remove').size() !=0) - Removed: - #foreach($actionItem in $release.getActions('remove')) - #processaction() - #end - #end +#if ($release.getActions('add').size() !=0) +New features: +#foreach($actionItem in $release.getActions('add')) +#processaction() +#end +#end + +#if ($release.getActions('fix').size() !=0) +Fixed Bugs: +#foreach($actionItem in $release.getActions('fix')) +#processaction() +#end +#end + +#if ($release.getActions('update').size() !=0) +Changes: +#foreach($actionItem in $release.getActions('update')) +#processaction() +#end +#end + +#if ($release.getActions('remove').size() !=0) +Removed: +#foreach($actionItem in $release.getActions('remove')) +#processaction() +#end +#end ## End of main loop #end -Historical list of changes: ${project.url}changes-report.html +Historical list of changes: ${project.url}/changes-report.html For complete information on ${project.name}, including instructions on how to submit bug reports, patches, or suggestions for improvement, see the Apache ${project.name} website: -${project.url} \ No newline at end of file +${project.url} + +Download page: ${project.url}/download_text.cgi + +Have fun! +-Apache Commons Team diff --git a/src/site/xdoc/download_commons-release-plugin.xml b/src/site/xdoc/download_commons-release-plugin.xml old mode 100755 new mode 100644 index bce003a..2fc7c04 --- a/src/site/xdoc/download_commons-release-plugin.xml +++ b/src/site/xdoc/download_commons-release-plugin.xml @@ -1,142 +1,144 @@ -<?xml version="1.0"?> -<!-- -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. ---> -<!-- - +======================================================================+ - |**** ****| - |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****| - |**** DO NOT EDIT DIRECTLY ****| - |**** ****| - +======================================================================+ - | TEMPLATE FILE: download-page-template.xml | - | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates | - +======================================================================+ - | | - | 1) Re-generate using: mvn commons:download-page | - | | - | 2) Set the following properties in the component's pom: | - | - commons.componentid (required, alphabetic, lower case) | - | - commons.release.version (required) | - | - commons.release.name (required) | - | - commons.binary.suffix (optional) | - | (defaults to "-bin", set to "" for pre-maven2 releases) | - | - commons.release.desc (optional) | - | - commons.release.subdir (optional) | - | | - | - commons.release.2/3.version (conditional) | - | - commons.release.2/3.name (conditional) | - | - commons.release.2/3.binary.suffix (optional) | - | - commons.release.2/3.desc (optional) | - | - commons.release.2/3.subdir (optional) | - | | - | 3) Example Properties | - | (commons.release.name inherited by parent: | - | ${project.artifactId}-${commons.release.version} | - | | - | <properties> | - | <commons.componentid>math</commons.componentid> | - | <commons.release.version>1.2</commons.release.version> | - | </properties> | - | | - +======================================================================+ ---> -<document> - <properties> - <title>Download Apache Commons Release Plugin</title> - <author email="d...@commons.apache.org">Apache Commons Documentation Team</author> - </properties> - <body> - <section name="Download Apache Commons Release Plugin"> - <subsection name="Using a Mirror"> - <p> - We recommend you use a mirror to download our release - builds, but you <strong>must</strong> <a href="http://www.apache.org/info/verification.html">verify the integrity</a> of - the downloaded files using signatures downloaded from our main - distribution directories. Recent releases (48 hours) may not yet - be available from all the mirrors. - </p> - - <p> - You are currently using <b>[preferred]</b>. If you - encounter a problem with this mirror, please select another - mirror. If all mirrors are failing, there are <i>backup</i> - mirrors (at the end of the mirrors list) that should be - available. - <br></br> - [if-any logo]<a href="[link]"><img align="right" src="[logo]" border="0"></img></a>[end] - </p> - - <form action="[location]" method="get" id="SelectMirror"> - <p> - Other mirrors: - <select name="Preferred"> - [if-any http] - [for http]<option value="[http]">[http]</option>[end] - [end] - [if-any ftp] - [for ftp]<option value="[ftp]">[ftp]</option>[end] - [end] - [if-any backup] - [for backup]<option value="[backup]">[backup] (backup)</option>[end] - [end] - </select> - <input type="submit" value="Change"></input> - </p> - </form> - - <p> - It is essential that you - <a href="https://www.apache.org/info/verification.html">verify the integrity</a> - of downloaded files, preferably using the <code>PGP</code> signature (<code>*.asc</code> files); - failing that using the <code>SHA512</code> hash (<code>*.sha512</code> checksum files). - </p> - <p> - The <a href="https://www.apache.org/dist/commons/KEYS">KEYS</a> - file contains the public PGP keys used by Apache Commons developers - to sign releases. - </p> - </subsection> - </section> - <section name="Apache Commons Release Plugin 1.7 "> +<?xml version="1.0"?> +<!-- +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. +--> +<!-- + +======================================================================+ + |**** ****| + |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****| + |**** DO NOT EDIT DIRECTLY ****| + |**** ****| + +======================================================================+ + | TEMPLATE FILE: download-page-template.xml | + | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates | + +======================================================================+ + | | + | 1) Re-generate using: mvn commons-build:download-page | + | | + | 2) Set the following properties in the component's pom: | + | - commons.componentid (required, alphabetic, lower case) | + | - commons.release.version (required) | + | - commons.release.name (required) | + | - commons.binary.suffix (optional) | + | (defaults to "-bin", set to "" for pre-maven2 releases) | + | - commons.release.desc (optional) | + | - commons.release.subdir (optional) | + | - commons.release.hash (optional, lowercase, default sha512) | + | | + | - commons.release.[234].version (conditional) | + | - commons.release.[234].name (conditional) | + | - commons.release.[234].binary.suffix (optional) | + | - commons.release.[234].desc (optional) | + | - commons.release.[234].subdir (optional) | + | - commons.release.[234].hash (optional, lowercase, [sha512])| + | | + | 3) Example Properties | + | (commons.release.name inherited by parent: | + | ${project.artifactId}-${commons.release.version} | + | | + | <properties> | + | <commons.componentid>math</commons.componentid> | + | <commons.release.version>1.2</commons.release.version> | + | </properties> | + | | + +======================================================================+ +--> +<document> + <properties> + <title>Download Apache Commons Release Plugin</title> + <author email="d...@commons.apache.org">Apache Commons Documentation Team</author> + </properties> + <body> + <section name="Download Apache Commons Release Plugin"> + <subsection name="Using a Mirror"> + <p> + We recommend you use a mirror to download our release + builds, but you <strong>must</strong> <a href="https://www.apache.org/info/verification.html">verify the integrity</a> of + the downloaded files using signatures downloaded from our main + distribution directories. Recent releases (48 hours) may not yet + be available from all the mirrors. + </p> + + <p> + You are currently using <b>[preferred]</b>. If you + encounter a problem with this mirror, please select another + mirror. If all mirrors are failing, there are <i>backup</i> + mirrors (at the end of the mirrors list) that should be + available. + <br></br> + [if-any logo]<a href="[link]"><img align="right" src="[logo]" border="0"></img></a>[end] + </p> + + <form action="[location]" method="get" id="SelectMirror"> + <p> + Other mirrors: + <select name="Preferred"> + [if-any http] + [for http]<option value="[http]">[http]</option>[end] + [end] + [if-any ftp] + [for ftp]<option value="[ftp]">[ftp]</option>[end] + [end] + [if-any backup] + [for backup]<option value="[backup]">[backup] (backup)</option>[end] + [end] + </select> + <input type="submit" value="Change"></input> + </p> + </form> + + <p> + It is essential that you + <a href="https://www.apache.org/info/verification.html">verify the integrity</a> + of downloaded files, preferably using the <code>PGP</code> signature (<code>*.asc</code> files); + failing that using the <code>SHA512</code> hash (<code>*.sha512</code> checksum files). + </p> + <p> + The <a href="https://www.apache.org/dist/commons/KEYS">KEYS</a> + file contains the public PGP keys used by Apache Commons developers + to sign releases. + </p> + </subsection> + </section> + <section name="Apache Commons Release Plugin 1.8.0 "> <subsection name="Binaries"> <table> <tr> - <td><a href="[preferred]/commons/commons-release-plugin/binaries/commons-release-plugin-1.7-bin.tar.gz">commons-release-plugin-1.7-bin.tar.gz</a></td> - <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/binaries/commons-release-plugin-1.7-bin.tar.gz.sha512">sha512</a></td> - <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/binaries/commons-release-plugin-1.7-bin.tar.gz.asc">pgp</a></td> + <td><a href="[preferred]/commons/commons-release-plugin/binaries/commons-release-plugin-1.8.0-bin.tar.gz">commons-release-plugin-1.8.0-bin.tar.gz</a></td> + <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/binaries/commons-release-plugin-1.8.0-bin.tar.gz.sha512">sha512</a></td> + <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/binaries/commons-release-plugin-1.8.0-bin.tar.gz.asc">pgp</a></td> </tr> <tr> - <td><a href="[preferred]/commons/commons-release-plugin/binaries/commons-release-plugin-1.7-bin.zip">commons-release-plugin-1.7-bin.zip</a></td> - <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/binaries/commons-release-plugin-1.7-bin.zip.sha512">sha512</a></td> - <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/binaries/commons-release-plugin-1.7-bin.zip.asc">pgp</a></td> + <td><a href="[preferred]/commons/commons-release-plugin/binaries/commons-release-plugin-1.8.0-bin.zip">commons-release-plugin-1.8.0-bin.zip</a></td> + <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/binaries/commons-release-plugin-1.8.0-bin.zip.sha512">sha512</a></td> + <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/binaries/commons-release-plugin-1.8.0-bin.zip.asc">pgp</a></td> </tr> </table> </subsection> <subsection name="Source"> <table> <tr> - <td><a href="[preferred]/commons/commons-release-plugin/source/commons-release-plugin-1.7-src.tar.gz">commons-release-plugin-1.7-src.tar.gz</a></td> - <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/source/commons-release-plugin-1.7-src.tar.gz.sha512">sha512</a></td> - <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/source/commons-release-plugin-1.7-src.tar.gz.asc">pgp</a></td> + <td><a href="[preferred]/commons/commons-release-plugin/source/commons-release-plugin-1.8.0-src.tar.gz">commons-release-plugin-1.8.0-src.tar.gz</a></td> + <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/source/commons-release-plugin-1.8.0-src.tar.gz.sha512">sha512</a></td> + <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/source/commons-release-plugin-1.8.0-src.tar.gz.asc">pgp</a></td> </tr> <tr> - <td><a href="[preferred]/commons/commons-release-plugin/source/commons-release-plugin-1.7-src.zip">commons-release-plugin-1.7-src.zip</a></td> - <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/source/commons-release-plugin-1.7-src.zip.sha512">sha512</a></td> - <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/source/commons-release-plugin-1.7-src.zip.asc">pgp</a></td> + <td><a href="[preferred]/commons/commons-release-plugin/source/commons-release-plugin-1.8.0-src.zip">commons-release-plugin-1.8.0-src.zip</a></td> + <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/source/commons-release-plugin-1.8.0-src.zip.sha512">sha512</a></td> + <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/source/commons-release-plugin-1.8.0-src.zip.asc">pgp</a></td> </tr> </table> </subsection> diff --git a/src/site/xdoc/issue-tracking.xml b/src/site/xdoc/issue-tracking.xml new file mode 100644 index 0000000..49ea460 --- /dev/null +++ b/src/site/xdoc/issue-tracking.xml @@ -0,0 +1,102 @@ +<?xml version="1.0"?> +<!-- +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. +--> +<!-- + +======================================================================+ + |**** ****| + |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****| + |**** DO NOT EDIT DIRECTLY ****| + |**** ****| + +======================================================================+ + | TEMPLATE FILE: issue-tracking-template.xml | + | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates | + +======================================================================+ + | | + | 1) Re-generate using: mvn commons-build:jira-page | + | | + | 2) Set the following properties in the component's pom: | + | - commons.jira.id (required, alphabetic, upper case) | + | - commons.jira.pid (required, numeric) | + | | + | 3) Example Properties | + | | + | <properties> | + | <commons.jira.id>MATH</commons.jira.id> | + | <commons.jira.pid>12310485</commons.jira.pid> | + | </properties> | + | | + +======================================================================+ +--> +<document> + <properties> + <title>Apache Commons Release Plugin Issue tracking</title> + <author email="d...@commons.apache.org">Apache Commons Documentation Team</author> + </properties> + <body> + + <section name="Apache Commons Release Plugin Issue tracking"> + <p> + Apache Commons Release Plugin uses <a href="https://issues.apache.org/jira/">ASF JIRA</a> for tracking issues. + See the <a href="https://issues.apache.org/jira/browse/COMMONSSITE">Apache Commons Release Plugin JIRA project page</a>. + </p> + + <p> + To use JIRA you may need to <a href="https://issues.apache.org/jira/secure/Signup!default.jspa">create an account</a> + (if you have previously created/updated Commons issues using Bugzilla an account will have been automatically + created and you can use the <a href="https://issues.apache.org/jira/secure/ForgotPassword!default.jspa">Forgot Password</a> + page to get a new password). + </p> + + <p> + If you would like to report a bug, or raise an enhancement request with + Apache Commons Release Plugin please do the following: + <ol> + <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310466&component=12312401&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">Search existing open bugs</a>. + If you find your issue listed then please add a comment with your details.</li> + <li><a href="mail-lists.html">Search the mailing list archive(s)</a>. + You may find your issue or idea has already been discussed.</li> + <li>Decide if your issue is a bug or an enhancement.</li> + <li>Submit either a <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310466&component=12312401&issuetype=1&priority=4&assignee=-1">bug report</a> + or <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310466&component=12312401&issuetype=4&priority=4&assignee=-1">enhancement request</a>.</li> + </ol> + </p> + + <p> + Please also remember these points: + <ul> + <li>the more information you provide, the better we can help you</li> + <li>test cases are vital, particularly for any proposed enhancements</li> + <li>the developers of Apache Commons Release Plugin are all unpaid volunteers</li> + </ul> + </p> + + <p> + For more information on subversion and creating patches see the + <a href="https://www.apache.org/dev/contributors.html">Apache Contributors Guide</a>. + </p> + + <p> + You may also find these links useful: + <ul> + <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310466&component=12312401&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">All Open Apache Commons Release Plugin bugs</a></li> + <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310466&component=12312401&sorter/field=issuekey&sorter/order=DESC&status=5&status=6">All Resolved Apache Commons Release Plugin bugs</a></li> + <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310466&component=12312401&sorter/field=issuekey&sorter/order=DESC">All Apache Commons Release Plugin bugs</a></li> + </ul> + </p> + </section> + </body> +</document> diff --git a/src/site/xdoc/mail-lists.xml b/src/site/xdoc/mail-lists.xml new file mode 100644 index 0000000..999d412 --- /dev/null +++ b/src/site/xdoc/mail-lists.xml @@ -0,0 +1,215 @@ +<?xml version="1.0"?> +<!-- +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. +--> +<!-- + +======================================================================+ + |**** ****| + |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****| + |**** DO NOT EDIT DIRECTLY ****| + |**** ****| + +======================================================================+ + | TEMPLATE FILE: mail-lists-template.xml | + | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates | + +======================================================================+ + | | + | 1) Re-generate using: mvn commons-build:mail-page | + | | + | 2) Set the following properties in the component's pom: | + | - commons.componentid (required, alphabetic, lower case) | + | | + | 3) Example Properties | + | | + | <properties> | + | <commons.componentid>math</commons.componentid> | + | </properties> | + | | + +======================================================================+ +--> +<document> + <properties> + <title>Apache Commons Release Plugin Mailing Lists</title> + <author email="d...@commons.apache.org">Apache Commons Documentation Team</author> + </properties> + <body> + + <section name="Overview"> + <p> + <a href="index.html">Apache Commons Release Plugin</a> shares mailing lists with all the other + <a href="https://commons.apache.org/components.html">Commons Components</a>. + To make it easier for people to only read messages related to components they are interested in, + the convention in Commons is to prefix the subject line of messages with the component's name, + for example: + <ul> + <li>[commons-release-plugin] Problem with the ...</li> + </ul> + </p> + <p> + Questions related to the usage of Apache Commons Release Plugin should be posted to the + <a href="https://mail-archives.apache.org/mod_mbox/commons-user/">User List</a>. + <br /> + The <a href="https://mail-archives.apache.org/mod_mbox/commons-dev/">Developer List</a> + is for questions and discussion related to the development of Apache Commons Release Plugin. + <br /> + Please do not cross-post; developers are also subscribed to the user list. + <br /> + You must be subscribed to post to the mailing lists. Follow the Subscribe links below + to subscribe. + </p> + <p> + <strong>Note:</strong> please don't send patches or attachments to any of the mailing lists. + Patches are best handled via the <a href="issue-tracking.html">Issue Tracking</a> system. + Otherwise, please upload the file to a public server and include the URL in the mail. + </p> + </section> + + <section name="Apache Commons Release Plugin Mailing Lists"> + <p> + <strong>Please prefix the subject line of any messages for <a href="index.html">Apache Commons Release Plugin</a> + with <i>[commons-release-plugin]</i></strong> - <i>thanks!</i> + <br /> + <br /> + </p> + + <table> + <tr> + <th>Name</th> + <th>Subscribe</th> + <th>Unsubscribe</th> + <th>Post</th> + <th>Archive</th> + <th>Other Archives</th> + </tr> + + + <tr> + <td> + <strong>Commons User List</strong> + <br /><br /> + Questions on using Apache Commons Release Plugin. + <br /><br /> + </td> + <td><a href="mailto:user-subscr...@commons.apache.org">Subscribe</a></td> + <td><a href="mailto:user-unsubscr...@commons.apache.org">Unsubscribe</a></td> + <td><a href="mailto:u...@commons.apache.org?subject=[commons-release-plugin]">Post</a></td> + <td><a href="https://mail-archives.apache.org/mod_mbox/commons-user/">mail-archives.apache.org</a><br /> + <a href="https://lists.apache.org/list.html?u...@commons.apache.org">lists.apache.org</a> + </td> + <td><a href="https://markmail.org/list/org.apache.commons.users/">markmail.org</a><br /> + <a href="https://www.mail-archive.com/user@commons.apache.org/">www.mail-archive.com</a><br /> + <a href="https://news.gmane.org/gmane.comp.jakarta.commons.devel">news.gmane.org</a> + </td> + </tr> + + + <tr> + <td> + <strong>Commons Developer List</strong> + <br /><br /> + Discussion of development of Apache Commons Release Plugin. + <br /><br /> + </td> + <td><a href="mailto:dev-subscr...@commons.apache.org">Subscribe</a></td> + <td><a href="mailto:dev-unsubscr...@commons.apache.org">Unsubscribe</a></td> + <td><a href="mailto:d...@commons.apache.org?subject=[commons-release-plugin]">Post</a></td> + <td><a href="https://mail-archives.apache.org/mod_mbox/commons-dev/">mail-archives.apache.org</a><br /> + <a href="https://lists.apache.org/list.html?d...@commons.apache.org">lists.apache.org</a> + </td> + <td><a href="https://markmail.org/list/org.apache.commons.dev/">markmail.org</a><br /> + <a href="https://www.mail-archive.com/dev@commons.apache.org/">www.mail-archive.com</a><br /> + <a href="https://news.gmane.org/gmane.comp.jakarta.commons.devel">news.gmane.org</a> + </td> + </tr> + + + <tr> + <td> + <strong>Commons Issues List</strong> + <br /><br /> + Only for e-mails automatically generated by the <a href="issue-tracking.html">issue tracking</a> system. + <br /><br /> + </td> + <td><a href="mailto:issues-subscr...@commons.apache.org">Subscribe</a></td> + <td><a href="mailto:issues-unsubscr...@commons.apache.org">Unsubscribe</a></td> + <td><i>read only</i></td> + <td><a href="https://mail-archives.apache.org/mod_mbox/commons-issues/">mail-archives.apache.org</a><br /> + <a href="https://lists.apache.org/list.html?iss...@commons.apache.org">lists.apache.org</a> + </td> + <td><a href="https://markmail.org/list/org.apache.commons.issues/">markmail.org</a><br /> + <a href="https://www.mail-archive.com/issues@commons.apache.org/">www.mail-archive.com</a> + </td> + </tr> + + + <tr> + <td> + <strong>Commons Commits List</strong> + <br /><br /> + Only for e-mails automatically generated by the <a href="scm.html">source control</a> sytem. + <br /><br /> + </td> + <td><a href="mailto:commits-subscr...@commons.apache.org">Subscribe</a></td> + <td><a href="mailto:commits-unsubscr...@commons.apache.org">Unsubscribe</a></td> + <td><i>read only</i></td> + <td><a href="https://mail-archives.apache.org/mod_mbox/commons-commits/">mail-archives.apache.org</a><br /> + <a href="https://lists.apache.org/list.html?commits@commons.apache.org">lists.apache.org</a> + </td> + <td><a href="https://markmail.org/list/org.apache.commons.commits/">markmail.org</a><br /> + <a href="https://www.mail-archive.com/commits@commons.apache.org/">www.mail-archive.com</a> + </td> + </tr> + + </table> + + </section> + <section name="Apache Mailing Lists"> + <p> + Other mailing lists which you may find useful include: + </p> + + <table> + <tr> + <th>Name</th> + <th>Subscribe</th> + <th>Unsubscribe</th> + <th>Post</th> + <th>Archive</th> + <th>Other Archives</th> + </tr> + <tr> + <td> + <strong>Apache Announce List</strong> + <br /><br /> + General announcements of Apache project releases. + <br /><br /> + </td> + <td><a class="externalLink" href="mailto:announce-subscr...@apache.org">Subscribe</a></td> + <td><a class="externalLink" href="mailto:announce-unsubscr...@apache.org">Unsubscribe</a></td> + <td><i>read only</i></td> + <td><a class="externalLink" href="https://mail-archives.apache.org/mod_mbox/www-announce/">mail-archives.apache.org</a><br /> + <a class="externalLink" href="https://lists.apache.org/list.html?annou...@apache.org">lists.apache.org</a> + </td> + <td><a class="externalLink" href="https://markmail.org/list/org.apache.announce/">markmail.org</a><br /> + <a class="externalLink" href="https://old.nabble.com/Apache-News-and-Announce-f109.html">old.nabble.com</a><br /> + <a class="externalLink" href="https://www.mail-archive.com/announce@apache.org/">www.mail-archive.com</a><br /> + <a class="externalLink" href="https://news.gmane.org/gmane.comp.apache.announce">news.gmane.org</a> + </td> + </tr> + </table> + + </section> + </body> +</document>