Skip to content

Commit 0d501b6

Browse files
committed
Prepare for the next release candidate
1 parent d6d4b82 commit 0d501b6

File tree

5 files changed

+82
-19
lines changed

5 files changed

+82
-19
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,11 @@ Making Changes
6161

6262
+ Create a _topic branch_ for your isolated work.
6363
* Usually you should base your branch from the `master` branch.
64-
* A good topic branch name can be the JIRA bug ID plus a keyword, for example, `CODEC-123-InputStream`.
64+
* A good topic branch name can be the JIRA bug ID plus a keyword, e.g. `CODEC-123-InputStream`.
6565
* If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests.
6666
+ Make commits of logical units.
6767
* Make sure your commit messages are meaningful and in the proper format. Your commit message should contain the key of the JIRA issue.
68-
* For example, `[CODEC-123] Close input stream earlier`
68+
* For example, `[CODEC-123] Close input stream sooner`
6969
+ Respect the original code style:
7070
+ Only use spaces for indentation; you can check for unnecessary whitespace with `git diff` before committing.
7171
+ 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.

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Apache Commons Codec
4545

4646
[![Java CI](https://github.com/apache/commons-codec/actions/workflows/maven.yml/badge.svg)](https://github.com/apache/commons-codec/actions/workflows/maven.yml)
4747
[![Maven Central](https://img.shields.io/maven-central/v/commons-codec/commons-codec?label=Maven%20Central)](https://search.maven.org/artifact/commons-codec/commons-codec)
48-
[![Javadocs](https://javadoc.io/badge/commons-codec/commons-codec/1.18.0.svg)](https://javadoc.io/doc/commons-codec/commons-codec/1.18.0)
48+
[![Javadocs](https://javadoc.io/badge/commons-codec/commons-codec/1.19.0.svg)](https://javadoc.io/doc/commons-codec/commons-codec/1.19.0)
4949
[![CodeQL](https://github.com/apache/commons-codec/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/apache/commons-codec/actions/workflows/codeql-analysis.yml)
5050
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/apache/commons-codec/badge)](https://api.securityscorecards.dev/projects/github.com/apache/commons-codec)
5151

@@ -71,7 +71,7 @@ Alternatively, you can pull it from the central Maven repositories:
7171
<dependency>
7272
<groupId>commons-codec</groupId>
7373
<artifactId>commons-codec</artifactId>
74-
<version>1.18.0</version>
74+
<version>1.19.0</version>
7575
</dependency>
7676
```
7777

@@ -93,7 +93,7 @@ There are some guidelines which will make applying PRs easier for us:
9393
+ 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.
9494
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running `mvn`.
9595
+ Before you pushing a PR, run `mvn` (by itself), this runs the default goal, which contains all build checks.
96-
+ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false`
96+
+ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false -Pjacoco`
9797

9898
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
9999
You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).

RELEASE-NOTES.txt

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,66 @@
1+
Apache Commons Codec 1.19.0 Release Notes
2+
-----------------------------------------
3+
4+
The Apache Commons Codec team is pleased to announce the release of Apache Commons Codec 1.19.0.
5+
6+
The Apache Commons Codec component contains encoders and decoders for
7+
formats such as Base16, Base32, Base64, digest, and Hexadecimal. In addition to these
8+
widely used encoders and decoders, the codec package also maintains a
9+
collection of phonetic encoding utilities.
10+
11+
This is a feature and maintenance release. Java 8 or later is required.
12+
13+
14+
New features
15+
------------
16+
17+
* Add HmacUtils.hmac(Path). Thanks to Gary Gregory.
18+
* Add HmacUtils.hmacHex(Path). Thanks to Gary Gregory.
19+
* Add PMD check to the default Maven goal. Thanks to Gary Gregory.
20+
* Add SpotBugs check to the default Maven goal. Thanks to Gary Gregory.
21+
22+
Fixed Bugs
23+
----------
24+
25+
* Remove -nouses directive from maven-bundle-plugin. OSGi package imports now state 'uses' definitions for package imports, this doesn't affect JPMS (from org.apache.commons:commons-parent:80). Thanks to Gary Gregory.
26+
* Refactor DigestUtils.updateDigest(MessageDigest, File) to use NIO. Thanks to Gary Gregory.
27+
* CODEC-328: Clarify Javadoc for org.apache.commons.codec.digest.UnixCrypt.crypt(byte[],String). Thanks to Gary Gregory.
28+
* Precompile regular expressions in DaitchMokotoffSoundex.Rule. Thanks to Gary Gregory.
29+
* Precompile regular expressions in DaitchMokotoffSoundex.parseRules(Scanner, String, Map, Map). Thanks to Gary Gregory.
30+
* Precompile regular expressions in Lang.loadFromResource(String, Languages). Thanks to Gary Gregory.
31+
* Precompile regular expressions in PhoneticEngine.encode(String, LanguageSet). Thanks to Gary Gregory.
32+
* Precompile regular expressions in org.apache.commons.codec.language.bm.Rule.parse*(*). Thanks to Gary Gregory.
33+
* Remove redundant checks for whitespace in DaitchMokotoffSoundex.soundex(String, boolean). Thanks to Gary Gregory.
34+
* Javadoc typo in Base16.java #380. Thanks to Sebastian Baunsgaard.
35+
* Deprecate unused constant org.apache.commons.codec.language.bm.Rule.ALL. Thanks to Gary Gregory.
36+
* CODEC-331: org.apache.commons.codec.language.bm.Rule.parsePhonemeExpr(String) adds duplicate empty phoneme when input ends with |. Thanks to IlikeCode, Gary Gregory.
37+
* CODEC-331: org.apache.commons.codec.language.DaitchMokotoffSoundex.cleanup(String) does not remove special characters like punctuation. Thanks to IlikeCode, Gary Gregory.
38+
* Fix PMD multiple UnnecessaryFullyQualifiedName in org.apache.commons.codec.binary.StringUtils. Thanks to Gary Gregory.
39+
* Fix PMD UnusedFormalParameter in private constructor in org.apache.commons.codec.binary.Base16. Thanks to Gary Gregory.
40+
* Fix PMD multiple UnnecessaryFullyQualifiedName in org.apache.commons.codec.digest.Blake3. Thanks to Gary Gregory.
41+
* Fix PMD UnnecessaryFullyQualifiedName in org.apache.commons.codec.digest.Md5Crypt. Thanks to Gary Gregory.
42+
* Fix PMD EmptyControlStatement in org.apache.commons.codec.language.Metaphone. Thanks to Gary Gregory.
43+
* Fix SpotBugs [ERROR] Medium: org.apache.commons.codec.binary.BaseNCodec$AbstractBuilder.setEncodeTable(byte[]) may expose internal representation by storing an externally mutable object into BaseNCodec$AbstractBuilder.encodeTable [org.apache.commons.codec.binary.BaseNCodec$AbstractBuilder] At BaseNCodec.java:[line 131] EI_EXPOSE_REP2. Thanks to Gary Gregory.
44+
* The method org.apache.commons.codec.binary.BaseNCodec.AbstractBuilder.setLineSeparator(byte...) now makes a defensive copy. Thanks to Gary Gregory.
45+
* Avoid unnecessary String conversion in org.apache.commons.codec.language.bm.PhoneticEngine.applyFinalRules(PhonemeBuilder, Map). Thanks to Gary Gregory.
46+
* Fix SpotBugs [ERROR] High: Potentially dangerous use of non-short-circuit logic in org.apache.commons.codec.language.DaitchMokotoffSoundex.cleanup(String) [org.apache.commons.codec.language.DaitchMokotoffSoundex] At DaitchMokotoffSoundex.java:[line 350] NS_DANGEROUS_NON_SHORT_CIRCUIT. Thanks to Gary Gregory.
47+
48+
Changes
49+
-------
50+
51+
* Bump org.apache.commons:commons-parent from 79 to 85 #375. Thanks to Gary Gregory, Dependabot.
52+
* [test] Bump commons-io:commons-io from 2.18.0 to 2.20.0. Thanks to Gary Gregory.
53+
* [test] Bump org.apache.commons:commons-lang3 from 3.17.0 to 3.18.0 #386. Thanks to Gary Gregory, Dependabot.
54+
55+
56+
For complete information on Apache Commons Codec, including instructions on how to submit bug reports,
57+
patches, or suggestions for improvement, see the Apache Commons Codec website:
58+
59+
https://commons.apache.org/proper/commons-codec/
60+
61+
Download page: https://commons.apache.org/proper/commons-codec/download_codec.cgi
62+
63+
---------------------------------------------------------------------------------
164
Apache Commons Codec 1.18.0 Release Notes
265
-----------------------------------------
366

src/changes/changes.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The <action> type attribute can be add,update,fix,remove.
4343
<author>Apache Commons Developers</author>
4444
</properties>
4545
<body>
46-
<release version="1.19.0" date="YYYY-MM-DD" description="This is a feature and maintenance release. Java 8 or later is required.">
46+
<release version="1.19.0" date="2025-07-19" description="This is a feature and maintenance release. Java 8 or later is required.">
4747
<!-- FIX -->
4848
<action type="fix" dev="ggregory" due-to="Gary Gregory">Remove -nouses directive from maven-bundle-plugin. OSGi package imports now state 'uses' definitions for package imports, this doesn't affect JPMS (from org.apache.commons:commons-parent:80).</action>
4949
<action type="fix" dev="ggregory" due-to="Gary Gregory">Refactor DigestUtils.updateDigest(MessageDigest, File) to use NIO.</action>

src/site/xdoc/download_codec.xml

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -115,32 +115,32 @@ limitations under the License.
115115
</p>
116116
</subsection>
117117
</section>
118-
<section name="Apache Commons Codec 1.18.0 ">
118+
<section name="Apache Commons Codec 1.19.0 ">
119119
<subsection name="Binaries">
120120
<table>
121121
<tr>
122-
<td><a href="[preferred]/commons/codec/binaries/commons-codec-1.18.0-bin.tar.gz">commons-codec-1.18.0-bin.tar.gz</a></td>
123-
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.18.0-bin.tar.gz.sha512">sha512</a></td>
124-
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.18.0-bin.tar.gz.asc">pgp</a></td>
122+
<td><a href="[preferred]/commons/codec/binaries/commons-codec-1.19.0-bin.tar.gz">commons-codec-1.19.0-bin.tar.gz</a></td>
123+
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.19.0-bin.tar.gz.sha512">sha512</a></td>
124+
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.19.0-bin.tar.gz.asc">pgp</a></td>
125125
</tr>
126126
<tr>
127-
<td><a href="[preferred]/commons/codec/binaries/commons-codec-1.18.0-bin.zip">commons-codec-1.18.0-bin.zip</a></td>
128-
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.18.0-bin.zip.sha512">sha512</a></td>
129-
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.18.0-bin.zip.asc">pgp</a></td>
127+
<td><a href="[preferred]/commons/codec/binaries/commons-codec-1.19.0-bin.zip">commons-codec-1.19.0-bin.zip</a></td>
128+
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.19.0-bin.zip.sha512">sha512</a></td>
129+
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.19.0-bin.zip.asc">pgp</a></td>
130130
</tr>
131131
</table>
132132
</subsection>
133133
<subsection name="Source">
134134
<table>
135135
<tr>
136-
<td><a href="[preferred]/commons/codec/source/commons-codec-1.18.0-src.tar.gz">commons-codec-1.18.0-src.tar.gz</a></td>
137-
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.18.0-src.tar.gz.sha512">sha512</a></td>
138-
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.18.0-src.tar.gz.asc">pgp</a></td>
136+
<td><a href="[preferred]/commons/codec/source/commons-codec-1.19.0-src.tar.gz">commons-codec-1.19.0-src.tar.gz</a></td>
137+
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.19.0-src.tar.gz.sha512">sha512</a></td>
138+
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.19.0-src.tar.gz.asc">pgp</a></td>
139139
</tr>
140140
<tr>
141-
<td><a href="[preferred]/commons/codec/source/commons-codec-1.18.0-src.zip">commons-codec-1.18.0-src.zip</a></td>
142-
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.18.0-src.zip.sha512">sha512</a></td>
143-
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.18.0-src.zip.asc">pgp</a></td>
141+
<td><a href="[preferred]/commons/codec/source/commons-codec-1.19.0-src.zip">commons-codec-1.19.0-src.zip</a></td>
142+
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.19.0-src.zip.sha512">sha512</a></td>
143+
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.19.0-src.zip.asc">pgp</a></td>
144144
</tr>
145145
</table>
146146
</subsection>

0 commit comments

Comments
 (0)