Skip to content

Commit

Permalink
Prepare for the next release candidate
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Dec 28, 2024
1 parent 4b32c49 commit 1c23ee9
Show file tree
Hide file tree
Showing 5 changed files with 59 additions and 23 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@ Apache Commons Codec

[![Java CI](https://github.com/apache/commons-codec/actions/workflows/maven.yml/badge.svg)](https://github.com/apache/commons-codec/actions/workflows/maven.yml)
[![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)
[![Javadocs](https://javadoc.io/badge/commons-codec/commons-codec/1.17.1.svg)](https://javadoc.io/doc/commons-codec/commons-codec/1.17.1)
[![Javadocs](https://javadoc.io/badge/commons-codec/commons-codec/1.17.2.svg)](https://javadoc.io/doc/commons-codec/commons-codec/1.17.2)
[![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)
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/apache/commons-codec/badge)](https://api.securityscorecards.dev/projects/github.com/apache/commons-codec)

The Apache Commons Codec component contains encoders and decoders for
various formats such as Base16, Base32, Base64, digest, and Hexadecimal. In addition to these
formats such as Base16, Base32, Base64, digest, and Hexadecimal. In addition to these
widely used encoders and decoders, the codec package also maintains a
collection of phonetic encoding utilities.

Expand All @@ -65,20 +65,20 @@ Getting the latest release
--------------------------
You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-codec/download_codec.cgi).

Alternatively, you can pull it from the central Maven repositories:
Alternatively, you can pull it from the central Maven repositories:

```xml
<dependency>
<groupId>commons-codec</groupId>
<artifactId>commons-codec</artifactId>
<version>1.17.1</version>
<version>1.17.2</version>
</dependency>
```

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.
Expand Down
38 changes: 37 additions & 1 deletion RELEASE-NOTES.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,40 @@
Apache Commons Codec 1.17.2 RELEASE NOTES
-----------------------------------------

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
collection of phonetic encoding utilities.

This is a feature and maintenance release. Java 8 or later is required.


Fixed Bugs
----------

* Rewrite DaitchMokotoffSoundex.soundex(String) using String.join(). Thanks to Gary Gregory.
* CODEC-324: Use Resource.class to load resources, rather than its class loader #353. Thanks to Michael Froh.
* Deprecate CharSequenceUtils.CharSequenceUtils(). Thanks to Gary Gregory.
* Deprecate Sha2Crypt.Sha2Crypt(). Thanks to Gary Gregory.

Changes
-------

* Bump org.apache.commons:commons-lang3 from 3.14.0 to 3.17.0 #296, #305, #313. Thanks to Dependabot.
* Bump org.apache.commons:commons-parent from 71 to 78 #310, #312, #319, #323, #326, #333. Thanks to Gary Gregory.
* [test] Bump commons-io:commons-io from 2.16.1 to 2.18.0 #318, #341. Thanks to Gary Gregory, Dependabot.
* Bump org.codehaus.mojo:taglist-maven-plugin from 3.1.0 to 3.2.1 #332. Thanks to Gary Gregory, Dependabot.


For complete information on Apache Commons Codec, including instructions on how to submit bug reports,
patches, or suggestions for improvement, see the Apache Commons Codec website:

https://commons.apache.org/proper/commons-codec/

Download page: https://commons.apache.org/proper/commons-codec/download_codec.cgi

---------------------------------------------------------------------------------

Apache Commons Codec 1.17.1 RELEASE NOTES
-----------------------------------------

Expand All @@ -9,7 +46,6 @@ collection of phonetic encoding utilities.
Feature and fix release. Requires a minimum of Java 8.



Fixed Bugs
----------

Expand Down
6 changes: 3 additions & 3 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,9 @@ limitations under the License.
<checkstyle.header.file>${basedir}/src/conf/checkstyle-header.txt</checkstyle.header.file>
<checkstyle.config.file>${basedir}/src/conf/checkstyle.xml</checkstyle.config.file>
<!-- Commons Release Plugin -->
<commons.release.version>1.17.1</commons.release.version>
<commons.bc.version>1.17.0</commons.bc.version>
<commons.bc.next>1.17.2</commons.bc.next>
<commons.release.version>1.17.2</commons.release.version>
<commons.bc.version>1.17.1</commons.bc.version>
<commons.release.next>1.17.3</commons.release.next>
<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>
Expand Down
2 changes: 1 addition & 1 deletion src/changes/changes.xml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The <action> type attribute can be add,update,fix,remove.
<author>Apache Commons Developers</author>
</properties>
<body>
<release version="1.17.2" date="YYYY-MM-DD" description="This is a feature and maintenance release. Java 8 or later is required.">
<release version="1.17.2" date="2024-12-28" description="This is a feature and maintenance release. Java 8 or later is required.">
<!-- FIX -->
<action type="fix" dev="ggregory" due-to="Gary Gregory">Rewrite DaitchMokotoffSoundex.soundex(String) using String.join().</action>
<action type="fix" issue="CODEC-324" dev="ggregory" due-to="Michael Froh">Use Resource.class to load resources, rather than its class loader #353.</action>
Expand Down
26 changes: 13 additions & 13 deletions src/site/xdoc/download_codec.xml
Original file line number Diff line number Diff line change
Expand Up @@ -113,32 +113,32 @@ limitations under the License.
</p>
</subsection>
</section>
<section name="Apache Commons Codec 1.17.1 ">
<section name="Apache Commons Codec 1.17.2 ">
<subsection name="Binaries">
<table>
<tr>
<td><a href="[preferred]/commons/codec/binaries/commons-codec-1.17.1-bin.tar.gz">commons-codec-1.17.1-bin.tar.gz</a></td>
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.17.1-bin.tar.gz.sha512">sha512</a></td>
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.17.1-bin.tar.gz.asc">pgp</a></td>
<td><a href="[preferred]/commons/codec/binaries/commons-codec-1.17.2-bin.tar.gz">commons-codec-1.17.2-bin.tar.gz</a></td>
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.17.2-bin.tar.gz.sha512">sha512</a></td>
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.17.2-bin.tar.gz.asc">pgp</a></td>
</tr>
<tr>
<td><a href="[preferred]/commons/codec/binaries/commons-codec-1.17.1-bin.zip">commons-codec-1.17.1-bin.zip</a></td>
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.17.1-bin.zip.sha512">sha512</a></td>
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.17.1-bin.zip.asc">pgp</a></td>
<td><a href="[preferred]/commons/codec/binaries/commons-codec-1.17.2-bin.zip">commons-codec-1.17.2-bin.zip</a></td>
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.17.2-bin.zip.sha512">sha512</a></td>
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.17.2-bin.zip.asc">pgp</a></td>
</tr>
</table>
</subsection>
<subsection name="Source">
<table>
<tr>
<td><a href="[preferred]/commons/codec/source/commons-codec-1.17.1-src.tar.gz">commons-codec-1.17.1-src.tar.gz</a></td>
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.17.1-src.tar.gz.sha512">sha512</a></td>
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.17.1-src.tar.gz.asc">pgp</a></td>
<td><a href="[preferred]/commons/codec/source/commons-codec-1.17.2-src.tar.gz">commons-codec-1.17.2-src.tar.gz</a></td>
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.17.2-src.tar.gz.sha512">sha512</a></td>
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.17.2-src.tar.gz.asc">pgp</a></td>
</tr>
<tr>
<td><a href="[preferred]/commons/codec/source/commons-codec-1.17.1-src.zip">commons-codec-1.17.1-src.zip</a></td>
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.17.1-src.zip.sha512">sha512</a></td>
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.17.1-src.zip.asc">pgp</a></td>
<td><a href="[preferred]/commons/codec/source/commons-codec-1.17.2-src.zip">commons-codec-1.17.2-src.zip</a></td>
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.17.2-src.zip.sha512">sha512</a></td>
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.17.2-src.zip.asc">pgp</a></td>
</tr>
</table>
</subsection>
Expand Down

0 comments on commit 1c23ee9

Please sign in to comment.