From f7ad2ef2f23f9693ea7d148ab52665b9e0ea5ccf Mon Sep 17 00:00:00 2001 From: Gary Gregory Date: Fri, 16 Aug 2024 12:43:46 +0000 Subject: [PATCH] Prepare for the next release candidate --- CONTRIBUTING.md | 9 ++++---- README.md | 8 +++---- RELEASE-NOTES.txt | 37 ++++++++++++++++++++++++++++++ src/changes/changes.xml | 2 +- src/site/xdoc/download_logging.xml | 26 ++++++++++----------- 5 files changed, 59 insertions(+), 23 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 082098a..bc0e81b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,9 +41,8 @@ Contributing to Apache Commons Logging ====================== -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 -the open source community. Before you dig right into the code there are a few guidelines that we need contributors to -follow so that we can have a chance of keeping on top of things. +Have you found a bug or have an idea for a cool new feature? Contributing code is a great way to give something back to the open-source community. +Before you dig right into the code, we need contributors to follow a few guidelines to have a chance of keeping on top of things. Getting Started --------------- @@ -62,7 +61,7 @@ Making Changes + Create a _topic branch_ for your isolated work. * Usually you should base your branch on the `master` branch. - * A good topic branch name can be the JIRA bug id plus a keyword, e.g. `LOGGING-123-InputStream`. + * A good topic branch name can be the JIRA bug ID plus a keyword, e.g. `LOGGING-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. @@ -72,7 +71,7 @@ Making 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. ++ Run all the tests with `mvn clean verify` to ensure nothing else was accidentally broken. Making Trivial Changes ---------------------- diff --git a/README.md b/README.md index caa5a3b..2ef5221 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ Apache Commons Logging [![Java CI](https://github.com/apache/commons-logging/actions/workflows/maven.yml/badge.svg)](https://github.com/apache/commons-logging/actions/workflows/maven.yml) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/commons-logging/commons-logging/badge.svg?gav=true)](https://maven-badges.herokuapp.com/maven-central/commons-logging/commons-logging/?gav=true) -[![Javadocs](https://javadoc.io/badge/commons-logging/commons-logging/1.3.3.svg)](https://javadoc.io/doc/commons-logging/commons-logging/1.3.3) +[![Javadocs](https://javadoc.io/badge/commons-logging/commons-logging/1.3.4.svg)](https://javadoc.io/doc/commons-logging/commons-logging/1.3.4) [![CodeQL](https://github.com/apache/commons-logging/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/apache/commons-logging/actions/workflows/codeql-analysis.yml) [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/apache/commons-logging/badge)](https://api.securityscorecards.dev/projects/github.com/apache/commons-logging) @@ -63,20 +63,20 @@ Getting the latest release -------------------------- You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-logging/download_logging.cgi). -Alternatively, you can pull it from the central Maven repositories: +Alternatively, you can pull it from the central Maven repositories: ```xml commons-logging commons-logging - 1.3.3 + 1.3.4 ``` Building -------- -Building requires a Java JDK and [Apache Maven](https://maven.apache.org/). +Building requires a Java JDK and [Apache Maven](https://maven.apache.org/). The required Java version is found in the `pom.xml` as the `maven.compiler.source` property. From a command shell, run `mvn` without arguments to invoke the default Maven goal to run all tests and checks. diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt index 7f58ead..885351b 100644 --- a/RELEASE-NOTES.txt +++ b/RELEASE-NOTES.txt @@ -1,3 +1,40 @@ +Apache Commons Logging 1.3.4 Release Notes +------------------------------------------ + +The Apache Commons Logging team is pleased to announce the release of Apache Commons Logging 1.3.4. + +Apache Commons Logging is a thin adapter allowing configurable bridging to other, +well-known logging systems. + +This is a feature and maintenance release. Java 8 or later is required. + +Changes in this version +----------------------- + + +Fixed Bugs +---------- + +* LOGGING-192: Fix factory loading from context class loader #280, #281. Thanks to Björn Kautler, Piotr Karwasz. + +Changes +------- + +* Bump org.apache.commons:commons-parent from 71 to 72. Thanks to Gary Gregory. +* Bump org.slf4j:slf4j-api from 2.0.13 to 2.0.16 #276, #282. Thanks to Gary Gregory, Dependabot. + + +Historical list of changes: https://commons.apache.org/proper/commons-logging/changes-report.html + +Download it from https://commons.apache.org/proper/commons-logging/download_logging.cgi + +For complete information on Apache Commons Logging, including instructions on how to submit bug reports, +patches, or suggestions for improvement, see the Apache Commons Logging website: + +https://commons.apache.org/proper/commons-logging/ + +----------------------------------------------------------------------------- + Apache Commons Logging 1.3.3 Release Notes ------------------------------------------ diff --git a/src/changes/changes.xml b/src/changes/changes.xml index 1cf4c7e..77014a8 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -43,7 +43,7 @@ The type attribute can be add,update,fix,remove. Release Notes - + Fix factory loading from context class loader #280, #281. diff --git a/src/site/xdoc/download_logging.xml b/src/site/xdoc/download_logging.xml index 16c87a9..b22e3f9 100644 --- a/src/site/xdoc/download_logging.xml +++ b/src/site/xdoc/download_logging.xml @@ -113,32 +113,32 @@ limitations under the License.

-
+
- - - + + + - - - + + +
commons-logging-1.3.3-bin.tar.gzsha512pgpcommons-logging-1.3.4-bin.tar.gzsha512pgp
commons-logging-1.3.3-bin.zipsha512pgpcommons-logging-1.3.4-bin.zipsha512pgp
- - - + + + - - - + + +
commons-logging-1.3.3-src.tar.gzsha512pgpcommons-logging-1.3.4-src.tar.gzsha512pgp
commons-logging-1.3.3-src.zipsha512pgpcommons-logging-1.3.4-src.zipsha512pgp