From bcc005a0fd6b99637adf46a04dc2d02632a0c7f0 Mon Sep 17 00:00:00 2001 From: Gary Gregory Date: Sun, 13 May 2018 10:30:15 -0600 Subject: [PATCH] Prepare for next release. --- CONTRIBUTING.md | 4 +- README.md | 20 +++-- src/site/xdoc/download_collections.xml | 116 +++++++++++++++++-------- src/site/xdoc/issue-tracking.xml | 54 ++++++------ src/site/xdoc/mail-lists.xml | 63 +++++++------- 5 files changed, 154 insertions(+), 103 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 536b11168..9b1dda68f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,7 +50,7 @@ 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 you're 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 Collections's scope. ++ 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 Collections'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. @@ -107,7 +107,7 @@ Additional Resources + [Apache Commons Collections 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) + `#apache-commons` IRC channel on `irc.freenode.net` diff --git a/README.md b/README.md index 3664ad287..71e09638e 100644 --- a/README.md +++ b/README.md @@ -42,22 +42,24 @@ ---> Apache Commons Collections =================== -[![Build Status](https://travis-ci.org/apache/commons-collections.svg?branch=trunk)](https://travis-ci.org/apache/commons-collections) -[![Coverage Status](https://coveralls.io/repos/apache/commons-collections/badge.svg?branch=trunk)](https://coveralls.io/r/apache/commons-collections) -[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-collections4/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-collections4/) -The Apache Commons Collections package contains types that extend and augment the Java Collections Framework. +[![Build Status](https://travis-ci.org/apache/commons-collections4.svg)](https://travis-ci.org/apache/commons-collections4) +[![Coverage Status](https://coveralls.io/repos/apache/commons-collections4/badge.svg)](https://coveralls.io/r/apache/commons-collections4) +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-collections4/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-collections4/) +[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-collections4/4.2.svg)](https://javadoc.io/doc/org.apache.commons/commons-collections4/4.2) + +${project.description} Documentation ------------- -More information can be found on the [Apache Commons Collections homepage](https://commons.apache.org/proper/commons-collections). -The [JavaDoc](https://commons.apache.org/proper/commons-collections/javadocs/api-release) can be browsed. +More information can be found on the [Apache Commons Collections homepage](https://commons.apache.org/proper/commons-collections4). +The [JavaDoc](https://commons.apache.org/proper/commons-collections4/javadocs/api-release) can be browsed. Questions related to the usage of Apache Commons Collections should be posted to the [user mailing list][ml]. Where can I get the latest release? ----------------------------------- -You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-collections/download_collections.cgi). +You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-collections4/download_collections4.cgi). Alternatively you can pull it from the central Maven repositories: @@ -65,7 +67,7 @@ Alternatively you can pull it from the central Maven repositories: org.apache.commons commons-collections4 - 4.1 + 4.2 ``` @@ -96,7 +98,7 @@ Additional Resources -------------------- + [Apache Commons Homepage](https://commons.apache.org/) -+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/browse/COLLECTIONS) ++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/COLLECTIONS) + [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) + `#apache-commons` IRC channel on `irc.freenode.org` diff --git a/src/site/xdoc/download_collections.xml b/src/site/xdoc/download_collections.xml index e43d9f03f..e7059671e 100644 --- a/src/site/xdoc/download_collections.xml +++ b/src/site/xdoc/download_collections.xml @@ -31,10 +31,21 @@ limitations under the License. | 2) Set the following properties in the component's pom: | | - commons.componentid (required, alphabetic, lower case) | | - commons.release.version (required) | - | - commons.binary.suffix (optional) | + | - 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} | | | | | | math | @@ -46,17 +57,17 @@ limitations under the License. Download Apache Commons Collections - Commons Documentation Team + Apache Commons Documentation Team

We recommend you use a mirror to download our release - builds, but you must verify the integrity of + builds, but you must verify the integrity of the downloaded files using signatures downloaded from our main distribution directories. Recent releases (48 hours) may not yet - be available from the mirrors. + be available from all the mirrors.

@@ -88,39 +99,74 @@ limitations under the License.

- The KEYS - link links to the code signing keys used to sign the product. - The PGP link downloads the OpenPGP compatible signature from our main site. - The MD5 link downloads the checksum from the main site. + It is essential that you + verify the integrity + of downloaded files, preferably using the PGP signature (*.asc files); + failing that using the SHA1 hash (*.sha1 checksum files). +

+

+ The KEYS + file contains the public PGP keys used by Apache Commons developers + to sign releases.

-
+
- - - + + + - - - + + +
commons-collections4-4.1-bin.tar.gzmd5pgpcommons-collections4-4.2-bin.tar.gzsha1pgp
commons-collections4-4.1-bin.zipmd5pgpcommons-collections4-4.2-bin.zipsha1pgp
- - - + + + - - - + + + + +
commons-collections4-4.1-src.tar.gzmd5pgpcommons-collections4-4.2-src.tar.gzsha1pgp
commons-collections4-4.1-src.zipmd5pgpcommons-collections4-4.2-src.zipsha1pgp
+ +
+
+ + + + + + + + + + + + +
commons-collections-4.1-bin.tar.gzsha1pgp
commons-collections-4.1-bin.zipsha1pgp
+ + + + + + + + + + + +
commons-collections-4.1-src.tar.gzsha1pgp
commons-collections-4.1-src.zipsha1pgp
@@ -129,28 +175,28 @@ limitations under the License. - - - + + + - - - + + +
commons-collections-3.2.2-bin.tar.gzmd5pgpcommons-collections-3.2.2-bin.tar.gzsha1pgp
commons-collections-3.2.2-bin.zipmd5pgpcommons-collections-3.2.2-bin.zipsha1pgp
- - - + + + - - - + + +
commons-collections-3.2.2-src.tar.gzmd5pgpcommons-collections-3.2.2-src.tar.gzsha1pgp
commons-collections-3.2.2-src.zipmd5pgpcommons-collections-3.2.2-src.zipsha1pgp
@@ -160,8 +206,8 @@ limitations under the License. Older releases can be obtained from the archives.

diff --git a/src/site/xdoc/issue-tracking.xml b/src/site/xdoc/issue-tracking.xml index 2c06da6dd..38a90af29 100644 --- a/src/site/xdoc/issue-tracking.xml +++ b/src/site/xdoc/issue-tracking.xml @@ -1,19 +1,19 @@ - Commons Collections Issue tracking - Commons Documentation Team + Apache Commons Collections Issue tracking + Apache Commons Documentation Team -
+

- Commons Collections uses ASF JIRA for tracking issues. - See the Commons Collections JIRA project page. + Apache Commons Collections uses ASF JIRA for tracking issues. + See the Apache Commons Collections JIRA project page.

- To use JIRA you may need to create an account + To use JIRA you may need to create an account (if you have previously created/updated Commons issues using Bugzilla an account will have been automatically - created and you can use the Forgot Password + created and you can use the Forgot Password page to get a new password).

If you would like to report a bug, or raise an enhancement request with - Commons Collections please do the following: + Apache Commons Collections please do the following:

    -
  1. Search existing open bugs. +
  2. Search existing open bugs. If you find your issue listed then please add a comment with your details.
  3. Search the mailing list archive(s). You may find your issue or idea has already been discussed.
  4. Decide if your issue is a bug or an enhancement.
    5. -
  5. Submit either a bug report - or enhancement request.
    6. +
  6. Submit either a bug report + or enhancement request.

@@ -80,7 +80,7 @@
  • the more information you provide, the better we can help you
  • test cases are vital, particularly for any proposed enhancements
    • -
  • the developers of Commons Collections are all unpaid volunteers
    • +
  • the developers of Apache Commons Collections are all unpaid volunteers

@@ -92,9 +92,9 @@

You may also find these links useful:

diff --git a/src/site/xdoc/mail-lists.xml b/src/site/xdoc/mail-lists.xml index db417896b..235557397 100644 --- a/src/site/xdoc/mail-lists.xml +++ b/src/site/xdoc/mail-lists.xml @@ -1,19 +1,19 @@ - Commons Collections Mailing Lists - Commons Documentation Team + Apache Commons Collections Mailing Lists + Apache Commons Documentation Team

- Commons Collections shares mailing lists with all the other + Apache Commons Collections shares mailing lists with all the other Commons Components. 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:

    -
  • [collections] Problem with the ...
    • +
  • [collections4] Problem with the ...

- Questions related to the usage of Commons Collections should be posted to the + Questions related to the usage of Apache Commons Collections should be posted to the User List.
The Developer List - is for questions and discussion related to the development of Commons Collections. + is for questions and discussion related to the development of Apache Commons Collections.
Please do not cross-post; developers are also subscribed to the user list. +
+ You must be subscribed to post to the mailing lists. Follow the Subscribe links below + to subscribe.

Note: please don't send patches or attachments to any of the mailing lists. - Patches are best handled via the Issue Tracking system. - Otherwise, please upload the file to a public server and include the URL in the mail. + Patches are best handled via the Issue Tracking system. + Otherwise, please upload the file to a public server and include the URL in the mail.

-
+

- Please prefix the subject line of any messages for Commons Collections - with [collections] - thanks! + Please prefix the subject line of any messages for Apache Commons Collections + with [collections4] - thanks!

@@ -96,12 +99,12 @@ Commons User List

- Questions on using Commons Collections. + Questions on using Apache Commons Collections.

Subscribe Unsubscribe - Post + Post mail-archives.apache.org markmail.org
www.mail-archive.com
@@ -114,12 +117,12 @@ Commons Developer List

- Discussion of development of Commons Collections. + Discussion of development of Apache Commons Collections.

Subscribe Unsubscribe - Post + Post mail-archives.apache.org markmail.org
www.mail-archive.com
@@ -185,10 +188,10 @@ General announcements of Apache project releases.

- Subscribe - Unsubscribe + Subscribe + Unsubscribe read only - mail-archives.apache.org + mail-archives.apache.org markmail.org
old.nabble.com
www.mail-archive.com