You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2025/11/20 11:39:06 UTC
(commons-configuration) branch master updated: Prepare for the next release candidate
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-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new 53490d4e5 Prepare for the next release candidate
53490d4e5 is described below
commit 53490d4e5afa967f3f7b3d2fd87dc9ecacb7e4c8
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Thu Nov 20 11:39:00 2025 +0000
Prepare for the next release candidate
---
CONTRIBUTING.md | 17 ++++----
README.md | 8 ++--
RELEASE-NOTES.txt | 66 ++++++++++++++++++++++++++++++++
pom.xml | 2 +-
src/changes/changes.xml | 2 +-
src/changes/release-notes.vm | 2 +-
src/site/xdoc/download_configuration.xml | 26 ++++++-------
src/site/xdoc/issue-tracking.xml | 12 +++---
src/site/xdoc/mail-lists.xml | 12 +++---
9 files changed, 110 insertions(+), 37 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index cf326050f..25c087bea 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -60,18 +60,21 @@ Making Changes
--------------
+ Create a _topic branch_ for your isolated work.
- * Usually you should base your branch on the `master` branch.
+ * Usually you should base your branch from the `master` branch.
* A good topic branch name can be the JIRA bug ID plus a keyword, e.g. `CONFIGURATION-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. `CONFIGURATION-123: Close input stream earlier`
+ * For example, `[CONFIGURATION-123] Close input stream sooner`
+ Respect the original code style:
- + Only use spaces for indentation.
+ + Only use spaces for indentation; you can check for unnecessary whitespace with `git diff` before committing.
+ 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 ensure nothing else was accidentally broken.
++ Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied. This may not always be possible but is a best practice.
+Unit tests are typically in the `src/test/java` directory.
++ Run a successful build using the default [Maven](https://maven.apache.org/) goal with `mvn`; that's `mvn` on the command line by itself.
++ Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
++ Each commit in the pull request should have a meaningful subject line and body. Note that commits might be squashed by a maintainer on merge.
+
Making Trivial Changes
----------------------
@@ -79,7 +82,7 @@ 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.
+In this case, it is appropriate to start the first line of a commit with '[doc]' or '[javadoc]' instead of a ticket number.
Submitting Changes
diff --git a/README.md b/README.md
index bb4e286dc..298d5bc9a 100644
--- a/README.md
+++ b/README.md
@@ -45,7 +45,7 @@ Apache Commons Configuration
[](https://github.com/apache/commons-configuration/actions/workflows/maven.yml)
[](https://search.maven.org/artifact/org.apache.commons/commons-configuration2)
-[](https://javadoc.io/doc/org.apache.commons/commons-configuration2/2.12.0)
+[](https://javadoc.io/doc/org.apache.commons/commons-configuration2/2.13.0)
[](https://github.com/apache/commons-configuration/actions/workflows/codeql-analysis.yml)
[](https://api.securityscorecards.dev/projects/github.com/apache/commons-configuration)
@@ -68,7 +68,7 @@ Alternatively, you can pull it from the central Maven repositories:
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-configuration2</artifactId>
- <version>2.12.0</version>
+ <version>2.13.0</version>
</dependency>
```
@@ -89,8 +89,8 @@ There are some guidelines which will make applying PRs easier for us:
+ Respect the existing code style for each file.
+ 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.
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running `mvn`.
-+ Before you pushing a PR, run `mvn` (by itself), this runs the default goal, which contains all build checks.
-+ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false`
++ Before you push a PR, run `mvn` (without arguments). This runs the default goal which contains all build checks.
++ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false -Pjacoco`
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt
index 801c0087d..7812babe7 100644
--- a/RELEASE-NOTES.txt
+++ b/RELEASE-NOTES.txt
@@ -1,3 +1,69 @@
+Apache Commons Configuration 2.13.0 Release Notes
+-------------------------------------------------
+
+The Apache Commons Configuration team is pleased to announce the release of Apache Commons Configuration 2.13.0.
+
+Introducing Apache Commons Configuration
+----------------------------------------
+
+The Apache Commons Team is pleased to announce Commons Configuration 2.13.0.
+
+This document contains the release notes for this version of the Commons
+Configuration component. It describes the changes since the previous version.
+The Commons Configuration software library provides a generic configuration
+interface which enables an application to read configuration data from a variety
+of sources.
+
+Tools to assist in the reading of configuration/preferences files in various formats; requires Java 8.
+
+Minor release with new features and updated dependencies; requires Java 8 or above.
+
+Changes in this version include:
+
+New features
+------------
+
+* Add org.apache.commons.configuration2.ImmutableConfiguration.entrySet(). Thanks to Gary Gregory.
+* Add org.apache.commons.configuration2.ImmutableConfiguration.forEach(BiConsumer<String, Object>). Thanks to Gary Gregory.
+* Add VEX entry for CVE-2025-48924 #587. Thanks to Piotr P. Karwasz, Gary Gregory.
+
+Fixed Bugs
+----------
+
+* Shared primitive variable "throwExceptionOnMissing" in one thread may not yield the value of the most recent write from another thread [org.apache.commons.configuration2.AbstractConfiguration] At AbstractConfiguration.java:[line 1493] AT_STALE_THREAD_WRITE_OF_PRIMITIVE. Thanks to Gary Gregory, SpotBugs.
+* Shared primitive variable "forceSingleLine" in one thread may not yield the value of the most recent write from another thread [org.apache.commons.configuration2.PropertiesConfigurationLayout] At PropertiesConfigurationLayout.java:[line 821] AT_STALE_THREAD_WRITE_OF_PRIMITIVE. Thanks to Gary Gregory, SpotBugs.
+* CONFIGURATION-849: Fix undoubling of strings #569. Thanks to Willy van Diepen, Gary Gregory, Rob Tompkins.
+* CONFIGURATION-852: Mark the package jakarta.servlet.* import as optional in OSGi #574. Thanks to Robbie Gemmell, Justin Bertram, Gary Gregory.
+* Fix build [WARNING] Parameter 'forkMode' is unknown for plugin 'maven-surefire-plugin:3.5.3:test (default-test)'. Thanks to Gary Gregory.
+
+Changes
+-------
+
+* Bump org.apache.commons:commons-parent from 81 to 92 #604, #623. Thanks to Gary Gregory, Dependabbot.
+* Bump com.fasterxml.jackson.core:jackson-databind from 2.18.3 to 2.20.1 #565, #599, #618. Thanks to Gary Gregory, Dependabot.
+* Bump commons-beanutils:commons-beanutils from 1.10.1 to 1.11.0. Thanks to Gary Gregory.
+* Bump log4j.version from 2.24.3 to 2.25.2 #579, #608. Thanks to Gary Gregory, Dependabot.
+* Bump org.apache.commons:commons-lang3 from 3.17.0 to 3.20.0 #582. Thanks to Gary Gregory, Dependabot.
+* Bump commons-io:commons-io from 2.19.0 to 2.21.0. Thanks to Gary Gregory.
+* Bump commons-codec:commons-codec from 1.18.0 to 1.20.0. Thanks to Gary Gregory.
+* Bump org.apache.commons:commons-text from 1.13.1 to 1.14.0. Thanks to Gary Gregory.
+* Bump com.sun.mail:mailapi from 2.0.1 to 2.0.2 (#586) #1627. Thanks to Gary Gregory, Dependabot.
+* Bump org.yaml:snakeyaml from 2.4 to 2.5 #601. Thanks to Gary Gregory, Dependabot.
+
+
+Historical list of changes: https://commons.apache.org/proper/commons-configuration/changes.html
+
+For complete information on Apache Commons Configuration, including instructions on how to submit bug reports,
+patches, or suggestions for improvement, see the Apache Apache Commons Configuration website:
+
+https://commons.apache.org/proper/commons-configuration/
+
+Download it from https://commons.apache.org/proper/commons-configuration//download_configuration.cgi
+
+Enjoy!
+Apache Commons Team
+
+-----------------------------------------------------------------------------
Apache Commons Configuration
Version 2.12.0
Release Notes
diff --git a/pom.xml b/pom.xml
index 820c0cfcc..9d6ef41ae 100644
--- a/pom.xml
+++ b/pom.xml
@@ -62,7 +62,7 @@
<spring.version>5.3.39</spring.version>
<japicmp.skip>false</japicmp.skip>
<!-- Commons Release Plugin -->
- <commons.bc.version>2.11.0</commons.bc.version>
+ <commons.bc.version>2.12.0</commons.bc.version>
<commons.rc.version>RC1</commons.rc.version>
<commons.release.isDistModule>true</commons.release.isDistModule>
<commons.distSvnStagingUrl>scm:svn:https://dist.apache.org/repos/dist/dev/commons/${commons.componentid}</commons.distSvnStagingUrl>
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 3c2604456..f5dcbd073 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -23,7 +23,7 @@
<author email="dev@commons.apache.org">Apache Commons Community</author>
</properties>
<body>
- <release version="2.13.0" date="YYYY-MM-DD" description="Minor release with new features and updated dependencies; requires Java 8 or above.">
+ <release version="2.13.0" date="2025-11-20" description="Minor release with new features and updated dependencies; requires Java 8 or above.">
<!-- FIX -->
<action type="fix" dev="ggregory" due-to="Gary Gregory, SpotBugs">Shared primitive variable "throwExceptionOnMissing" in one thread may not yield the value of the most recent write from another thread [org.apache.commons.configuration2.AbstractConfiguration] At AbstractConfiguration.java:[line 1493] AT_STALE_THREAD_WRITE_OF_PRIMITIVE.</action>
<action type="fix" dev="ggregory" due-to="Gary Gregory, SpotBugs">Shared primitive variable "forceSingleLine" in one thread may not yield the value of the most recent write from another thread [org.apache.commons.configuration2.PropertiesConfigurationLayout] At PropertiesConfigurationLayout.java:[line 821] AT_STALE_THREAD_WRITE_OF_PRIMITIVE.</action>
diff --git a/src/changes/release-notes.vm b/src/changes/release-notes.vm
index 28d5f6d0f..4e19aa050 100644
--- a/src/changes/release-notes.vm
+++ b/src/changes/release-notes.vm
@@ -16,7 +16,7 @@
## under the License.
##
${project.name} ${version} Release Notes
-------------------------------------------------
+-------------------------------------------------
The ${developmentTeam} is pleased to announce the release of ${project.name} ${version}.
diff --git a/src/site/xdoc/download_configuration.xml b/src/site/xdoc/download_configuration.xml
index c7ec99a3c..0601ac271 100644
--- a/src/site/xdoc/download_configuration.xml
+++ b/src/site/xdoc/download_configuration.xml
@@ -115,32 +115,32 @@ limitations under the License.
</p>
</subsection>
</section>
- <section name="Apache Commons Configuration 2.12.0 (Java 8 or above)">
+ <section name="Apache Commons Configuration 2.13.0 (Java 8 or above)">
<subsection name="Binaries">
<table>
<tr>
- <td><a href="[preferred]/commons/configuration/binaries/commons-configuration2-2.12.0-bin.tar.gz">commons-configuration2-2.12.0-bin.tar.gz</a></td>
- <td><a href="https://downloads.apache.org/commons/configuration/binaries/commons-configuration2-2.12.0-bin.tar.gz.sha512">sha512</a></td>
- <td><a href="https://downloads.apache.org/commons/configuration/binaries/commons-configuration2-2.12.0-bin.tar.gz.asc">pgp</a></td>
+ <td><a href="[preferred]/commons/configuration/binaries/commons-configuration2-2.13.0-bin.tar.gz">commons-configuration2-2.13.0-bin.tar.gz</a></td>
+ <td><a href="https://downloads.apache.org/commons/configuration/binaries/commons-configuration2-2.13.0-bin.tar.gz.sha512">sha512</a></td>
+ <td><a href="https://downloads.apache.org/commons/configuration/binaries/commons-configuration2-2.13.0-bin.tar.gz.asc">pgp</a></td>
</tr>
<tr>
- <td><a href="[preferred]/commons/configuration/binaries/commons-configuration2-2.12.0-bin.zip">commons-configuration2-2.12.0-bin.zip</a></td>
- <td><a href="https://downloads.apache.org/commons/configuration/binaries/commons-configuration2-2.12.0-bin.zip.sha512">sha512</a></td>
- <td><a href="https://downloads.apache.org/commons/configuration/binaries/commons-configuration2-2.12.0-bin.zip.asc">pgp</a></td>
+ <td><a href="[preferred]/commons/configuration/binaries/commons-configuration2-2.13.0-bin.zip">commons-configuration2-2.13.0-bin.zip</a></td>
+ <td><a href="https://downloads.apache.org/commons/configuration/binaries/commons-configuration2-2.13.0-bin.zip.sha512">sha512</a></td>
+ <td><a href="https://downloads.apache.org/commons/configuration/binaries/commons-configuration2-2.13.0-bin.zip.asc">pgp</a></td>
</tr>
</table>
</subsection>
<subsection name="Source">
<table>
<tr>
- <td><a href="[preferred]/commons/configuration/source/commons-configuration2-2.12.0-src.tar.gz">commons-configuration2-2.12.0-src.tar.gz</a></td>
- <td><a href="https://downloads.apache.org/commons/configuration/source/commons-configuration2-2.12.0-src.tar.gz.sha512">sha512</a></td>
- <td><a href="https://downloads.apache.org/commons/configuration/source/commons-configuration2-2.12.0-src.tar.gz.asc">pgp</a></td>
+ <td><a href="[preferred]/commons/configuration/source/commons-configuration2-2.13.0-src.tar.gz">commons-configuration2-2.13.0-src.tar.gz</a></td>
+ <td><a href="https://downloads.apache.org/commons/configuration/source/commons-configuration2-2.13.0-src.tar.gz.sha512">sha512</a></td>
+ <td><a href="https://downloads.apache.org/commons/configuration/source/commons-configuration2-2.13.0-src.tar.gz.asc">pgp</a></td>
</tr>
<tr>
- <td><a href="[preferred]/commons/configuration/source/commons-configuration2-2.12.0-src.zip">commons-configuration2-2.12.0-src.zip</a></td>
- <td><a href="https://downloads.apache.org/commons/configuration/source/commons-configuration2-2.12.0-src.zip.sha512">sha512</a></td>
- <td><a href="https://downloads.apache.org/commons/configuration/source/commons-configuration2-2.12.0-src.zip.asc">pgp</a></td>
+ <td><a href="[preferred]/commons/configuration/source/commons-configuration2-2.13.0-src.zip">commons-configuration2-2.13.0-src.zip</a></td>
+ <td><a href="https://downloads.apache.org/commons/configuration/source/commons-configuration2-2.13.0-src.zip.sha512">sha512</a></td>
+ <td><a href="https://downloads.apache.org/commons/configuration/source/commons-configuration2-2.13.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
index 9ed1b227e..7052ce862 100644
--- a/src/site/xdoc/issue-tracking.xml
+++ b/src/site/xdoc/issue-tracking.xml
@@ -41,10 +41,12 @@ limitations under the License.
| |
+======================================================================+
-->
-<document>
+<document xmlns="http://maven.apache.org/XDOC/2.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
<properties>
<title>Apache Commons Configuration Issue tracking</title>
- <author email="dev@commons.apache.org">Apache Commons Documentation Team</author>
+ <author email="dev@commons.apache.org">Apache Commons Team</author>
</properties>
<body>
@@ -64,6 +66,7 @@ limitations under the License.
<p>
If you would like to report a bug, or raise an enhancement request with
Apache Commons Configuration please do the following:
+ </p>
<ol>
<li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310467&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>
@@ -73,16 +76,15 @@ limitations under the License.
<li>Submit either a <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310467&issuetype=1&priority=4&assignee=-1">bug report</a>
or <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310467&issuetype=4&priority=4&assignee=-1">enhancement request</a>.</li>
</ol>
- </p>
<p>
Please also remember these points:
+ </p>
<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 Configuration are all unpaid volunteers</li>
</ul>
- </p>
<p>
For more information on creating patches see the
@@ -91,12 +93,12 @@ limitations under the License.
<p>
You may also find these links useful:
+ </p>
<ul>
<li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310467&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">All Open Apache Commons Configuration bugs</a></li>
<li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310467&sorter/field=issuekey&sorter/order=DESC&status=5&status=6">All Resolved Apache Commons Configuration bugs</a></li>
<li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310467&sorter/field=issuekey&sorter/order=DESC">All Apache Commons Configuration bugs</a></li>
</ul>
- </p>
</section>
</body>
</document>
diff --git a/src/site/xdoc/mail-lists.xml b/src/site/xdoc/mail-lists.xml
index 88960d630..4a34d790d 100644
--- a/src/site/xdoc/mail-lists.xml
+++ b/src/site/xdoc/mail-lists.xml
@@ -39,10 +39,12 @@ limitations under the License.
| |
+======================================================================+
-->
-<document>
+<document xmlns="http://maven.apache.org/XDOC/2.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
<properties>
<title>Apache Commons Configuration Mailing Lists</title>
- <author email="dev@commons.apache.org">Apache Commons Documentation Team</author>
+ <author email="dev@commons.apache.org">Apache Commons Team</author>
</properties>
<body>
@@ -53,10 +55,10 @@ limitations under the License.
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>[configuration] Problem with the ...</li>
- </ul>
</p>
+ <ul>
+ <li>[configuration] Problem with the ...</li>
+ </ul>
<p>
Questions related to the usage of Apache Commons Configuration should be posted to the
<a href="https://lists.apache.org/list.html?user@commons.apache.org">User List</a>.