You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by tv...@apache.org on 2021/12/23 15:37:39 UTC
[commons-jcs] 06/06: Prepare release
This is an automated email from the ASF dual-hosted git repository.
tv pushed a commit to branch release-3.1
in repository https://gitbox.apache.org/repos/asf/commons-jcs.git
commit a29701ddcf8cb636e82a8d5adc4f8451dcf84960
Author: Thomas Vandahl <tv...@apache.org>
AuthorDate: Thu Dec 23 16:37:30 2021 +0100
Prepare release
---
CONTRIBUTING.md | 44 ++++++++++++++++++++++++++-----------
README.md | 23 +++++++++++++-------
RELEASE-NOTES.txt | 58 ++++++++++++++++++++++++++++++++-----------------
src/changes/changes.xml | 2 +-
4 files changed, 85 insertions(+), 42 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 47c385f..019a516 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -25,7 +25,7 @@
| 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) |
@@ -51,47 +51,65 @@ 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 JCS's scope.
-+ Submit a ticket for your issue, assuming one does not already exist.
++ 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. `JCS-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. `JCS-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 JCS JIRA project page](https://issues.apache.org/jira/browse/JCS)
++ [Apache Commons JCS 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/JCS
diff --git a/README.md b/README.md
index ddafd09..a208ed5 100644
--- a/README.md
+++ b/README.md
@@ -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) |
@@ -43,13 +43,18 @@
Apache Commons JCS
===================
+[](https://travis-ci.org/apache/commons-jcs)
+[](https://coveralls.io/r/apache/commons-jcs)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-jcs3/)
+[](https://javadoc.io/doc/org.apache.commons/commons-jcs3/3.1)
+
Apache Commons JCS is a distributed, versatile caching system.
Documentation
-------------
-More information can be found on the [homepage](https://commons.apache.org/proper/commons-jcs).
-The [Javadoc](https://commons.apache.org/proper/commons-jcs/javadocs/api-release) can be browsed.
+More information can be found on the [Apache Commons JCS homepage](https://commons.apache.org/proper/commons-jcs).
+The [Javadoc](https://commons.apache.org/proper/commons-jcs/apidocs) can be browsed.
Questions related to the usage of Apache Commons JCS should be posted to the [user mailing list][ml].
Where can I get the latest release?
@@ -62,14 +67,14 @@ Alternatively you can pull it from the central Maven repositories:
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-jcs3</artifactId>
- <version>3.0</version>
+ <version>3.1</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.
@@ -81,7 +86,9 @@ You can learn more about contributing via GitHub in our [contribution guidelines
License
-------
-Code is under the [Apache Licence 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
---------
@@ -91,8 +98,8 @@ Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
-+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/JCS)
+ [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 abf489d..0a3e544 100644
--- a/RELEASE-NOTES.txt
+++ b/RELEASE-NOTES.txt
@@ -16,13 +16,13 @@ limitations under the License.
Apache Commons JCS
- Version 3.0
+ Version 3.1
Release Notes
INTRODUCTION:
-This document contains the release notes for the 3.0 version of Apache Commons JCS.
+This document contains the release notes for the 3.1 version of Apache Commons JCS.
Commons JCS is a distributed caching system written in Java. It is intend to speed up
applications by providing a means to manage cached data of various dynamic natures.
@@ -36,30 +36,48 @@ For the advice on upgrading from 2.x to 3.x, see the following page:
Changes in this version include:
New features:
-o JCS-46: Add configuration option to specify the datagram
- time-to-live in UDPDiscoverySender
-o Add configuration option to specify the network interface
- to use for UDP multicast
-o JCS-166: Add configuration option to specify the host to bind the
- LateralTCPListener to
-o JCS-122: Add a log abstraction layer for java.util.logging or log4j2
-o Add a get method to CacheAccess that allows a Supplier to be specified
+o Add EncryptingSerializer and some documentation
+o Add BlockDiskKeyStore.isEmpty(). Thanks to Gary Gregory.
+o Add IndexedDisk.isEmpty(). Thanks to Gary Gregory.
Fixed Bugs:
-o JCS-205: Fix packaging
-o JCS-199: Properly shut down auxiliary caches
-o JCS-182: Fix NPE while closing data source
-o JCS-201: Fix initialization sequence
+o JCS-228: Attempt to fix osgi import packages Thanks to Patrick Ziegler.
+o JCS-191: Fix for Server Failover mechanism not working, add test Thanks to Prajakta Uplaikar.
+o JCS-186: Use configured listener address for UDP service broadcast Thanks to Alex L.
+o JCS-186: Fix UDP service discovery with LateralCache Thanks to Alex L.
+o Fix shutdown race conditions
Changes:
-o JCS-181: Update dependency to httpclient 4.5.3
-o Update dependency commons-dbcp2
-o Finally require Java 8
+o Update from Apache Log4j 2.15.0 to 2.17.0 Thanks to Gary Gregory.
+o Autodetect lateral service address on the interface used for multicast -
+ depending on the multicast protocol:
+ IPv6 link-local address for IPv6 multicast,
+ IPv4 site-local address for IPv4 multicast
+o Use NIO for UDP service discovery, works with IPv6 now
+o Use NIO for LateralTCPListener
+o IMPORTANT CHANGE
+ Use IElementSerializer for LateralTCPSender and listener
+o IMPORTANT CHANGE
+ Use IElementSerializer for RemoteHttpCacheServlet
+o IMPORTANT CHANGE
+ Use IElementSerializer for Block disk key storage
+o IMPORTANT CHANGE
+ Use IElementSerializer for UDP service discovery
+o Replace several Runnable classes with Lambdas
+ Deprecate original classes
+o Update from Apache Commons Lang 3.10 to 3.12.0. Thanks to Gary Gregory.
+o Bump build actions/setup-java from v1.4.3 to v2. Thanks to Gary Gregory.
+o Update from Apache Commons IO 2.8.0 to 2.10.0, #72. Thanks to Gary Gregory, Dependabot.
+o Bump actions/cache from 2.1.5 to 2.1.6 #70. Thanks to Dependabot.
+o Bump log4j-api from 2.13.2 to 2.17.0 #79. Thanks to Dependabot.
Removed:
-o JCS-122: Remove dependency on commons-logging
-o Remove dependency on velocity-tools
-o Remove deprecated code
+o Remove support for long deprecated and inconsistent
+ RemoteCacheServer configuration keys
+ - remote.cache.service.port is now jcs.remotecache.serverattributes.servicePort
+ - remote.cache.rmiSocketFactoryTimeoutMillis is now jcs.remotecache.serverattributes.rmiSocketFactoryTimeoutMillis
+ - remote.cluster.LocalClusterConsistency is now jcs.remotecache.serverattributes.LocalClusterConsistency
+ - remote.cluster.AllowClusterGet is now jcs.remotecache.serverattributes.AllowClusterGet
Historical list of changes: http://commons.apache.org/proper/commons-jcs/changes-report.html
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index fc6e8c3..8e50f01 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -19,7 +19,7 @@
<author email="dev@commons.apache.org">Apache Commons Developers</author>
</properties>
<body>
- <release version="3.1" date="20YY-MM-DD">
+ <release version="3.1" date="2021-12-23">
<action dev="tv" type="fix" due-to="Patrick Ziegler" issue="JCS-228">
Attempt to fix osgi import packages
</action>