Merge branch 'master' of https://gitbox.apache.org/repos/asf/commons-codec.git

Author: garydgregory

CONTRIBUTING.md

@@ -60,26 +60,29 @@ 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. `CODEC-123-InputStream`.
+  * Usually you should base your branch from the `master` branch.
+  * A good topic branch name can be the JIRA bug ID plus a keyword, for example, `CODEC-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. `CODEC-123: Close input stream earlier`
+  * For example, `[CODEC-123] Close input stream earlier`
 + 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
 ----------------------
 
 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

RELEASE-NOTES.txt

@@ -1,6 +1,8 @@
-Apache Commons Codec 1.18.0 RELEASE NOTES
+Apache Commons Codec 1.18.0 Release Notes
 -----------------------------------------
 
+The Apache Commons Codec team is pleased to announce the release of Apache Commons Codec 1.18.0. 
+
 The Apache Commons Codec component contains encoders and decoders for
 formats such as Base16, Base32, Base64, digest, and Hexadecimal. In addition to these
 widely used encoders and decoders, the codec package also maintains a
@@ -31,7 +33,7 @@ Download page: https://commons.apache.org/proper/commons-codec/download_codec.cg
 
 ---------------------------------------------------------------------------------
 
-Apache Commons Codec 1.17.2 RELEASE NOTES
+Apache Commons Codec 1.17.2 Release Notes
 -----------------------------------------
 
 The Apache Commons Codec component contains encoders and decoders for
@@ -68,7 +70,7 @@ Download page: https://commons.apache.org/proper/commons-codec/download_codec.cg
 
 ---------------------------------------------------------------------------------
 
-Apache Commons Codec 1.17.1 RELEASE NOTES
+Apache Commons Codec 1.17.1 Release Notes
 -----------------------------------------
 
 The Apache Commons Codec component contains encoders and decoders for
@@ -101,7 +103,7 @@ Download page: https://commons.apache.org/proper/commons-codec/download_codec.cg
 
 ---------------------------------------------------------------------------------
 
-Apache Commons Codec 1.17.0 RELEASE NOTES
+Apache Commons Codec 1.17.0 Release Notes
 -----------------------------------------
 
 The Apache Commons Codec component contains encoders and decoders for
@@ -149,7 +151,7 @@ Download page: https://commons.apache.org/proper/commons-codec/download_codec.cg
 
 ---------------------------------------------------------------------------------
 
-Apache Commons Codec 1.16.1 RELEASE NOTES
+Apache Commons Codec 1.16.1 Release Notes
 -----------------------------------------
 
 The Apache Commons Codec component contains encoders and decoders for

pom.xml

@@ -28,7 +28,7 @@ limitations under the License.
   </parent>
   <groupId>commons-codec</groupId>
   <artifactId>commons-codec</artifactId>
-  <version>1.18.0-SNAPSHOT</version>
+  <version>1.18.1-SNAPSHOT</version>
   <name>Apache Commons Codec</name>
   <inceptionYear>2002</inceptionYear>
   <description>
@@ -100,7 +100,7 @@ limitations under the License.
     <commons.release.isDistModule>true</commons.release.isDistModule>
     <commons.distSvnStagingUrl>scm:svn:https://dist.apache.org/repos/dist/dev/commons/${commons.componentid}</commons.distSvnStagingUrl>
     <!-- project.build.outputTimestamp is managed by Maven plugins, see https://maven.apache.org/guides/mini/guide-reproducible-builds.html -->
-    <project.build.outputTimestamp>2025-01-06T22:01:21Z</project.build.outputTimestamp>
+    <project.build.outputTimestamp>2025-01-27T18:05:48Z</project.build.outputTimestamp>
     <commons.jacoco.version>0.8.12</commons.jacoco.version>
     <!-- Temp for SUREFIRE-2253 -->
     <commons.surefire.version>3.2.5</commons.surefire.version>

src/changes/changes.xml

@@ -43,6 +43,11 @@ The <action> type attribute can be add,update,fix,remove.
     <author>Apache Commons Developers</author>
   </properties>
   <body>
+    <release version="1.18.1" date="YYYY-MM-DD" description="This is a feature and maintenance release. Java 8 or later is required.">
+      <!-- FIX -->
+      <!-- ADD -->
+      <!-- UPDATE -->
+    </release>
     <release version="1.18.0" date="2025-01-24" description="This is a feature and maintenance release. Java 8 or later is required.">
       <!-- FIX -->
       <!-- ADD -->

src/changes/release-notes.vm

@@ -14,9 +14,11 @@
 ## KIND, either express or implied.  See the License for the
 ## specific language governing permissions and limitations
 ## under the License.
-${project.name} ${version} RELEASE NOTES
+${project.name} ${version} Release Notes
 -----------------------------------------
 
+The ${developmentTeam} is pleased to announce the release of ${project.name} ${version}.
+
 $introduction.replaceAll("(?<!\015)\012", "
 ").replaceAll("(?m)^ +","")