Prepare for the next release candidate

apache · Apr 20, 2024 · 9a59c1c · 9a59c1c
1 parent 5f0cfd4
commit 9a59c1c
Show file tree

Hide file tree

Showing 4 changed files with 64 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -46,7 +46,7 @@ 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)
 [![Coverage Status](https://codecov.io/gh/apache/commons-codec/branch/master/graph/badge.svg)](https://app.codecov.io/gh/apache/commons-codec)
 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/commons-codec/commons-codec/badge.svg?gav=true)](https://maven-badges.herokuapp.com/maven-central/commons-codec/commons-codec/?gav=true)
-[![Javadocs](https://javadoc.io/badge/commons-codec/commons-codec/1.16.1.svg)](https://javadoc.io/doc/commons-codec/commons-codec/1.16.1)
+[![Javadocs](https://javadoc.io/badge/commons-codec/commons-codec/1.17.0.svg)](https://javadoc.io/doc/commons-codec/commons-codec/1.17.0)
 [![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)
 
@@ -72,7 +72,7 @@ Alternatively, you can pull it from  the central Maven repositories:
 <dependency>
   <groupId>commons-codec</groupId>
   <artifactId>commons-codec</artifactId>
-  <version>1.16.1</version>
+  <version>1.17.0</version>
 </dependency>
 ```
 

diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt
@@ -1,3 +1,51 @@
+Apache Commons Codec 1.17.0 RELEASE NOTES
+-----------------------------------------
+
+The Apache Commons Codec component contains encoder and decoders for
+various 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.
+
+Feature and fix release. Requires a minimum of Java 8.
+
+
+New features
+------------
+
+*             Add override org.apache.commons.codec.language.bm.Rule.PhonemeExpr.size(). Thanks to Gary Gregory.
+*             Add support for Base64 custom alphabets #266. Thanks to Chris Kocel, Gary Gregory.
+*             Add Base64.Builder (allows custom alphabets). Thanks to Gary Gregory.
+*             Add Base32.Builder (allows custom alphabets). Thanks to Gary Gregory.
+*             Add Base64 support for a custom padding byte (like Base32). Thanks to Gary Gregory.
+
+Fixed Bugs
+----------
+
+* CODEC-320:  Wrong output of DoubleMetaphone in 1.16.1. Thanks to Martin Frydl, Gary Gregory.
+*             Optimize memory allocation in PhoneticEngine. Thanks to Gary Gregory.
+*             BCodec and QCodec encode() methods throw UnsupportedCharsetException instead of EncoderException. Thanks to Gary Gregory.
+*             Set Javadoc link to latest Java API LTS version. Thanks to Gary Gregory.
+*             Base32 constructor fails-fast with a NullPointerException if the custom alphabet array is null. Thanks to Gary Gregory.
+*             Base32 constructor makes a defensive copy of the line separator array. Thanks to Gary Gregory.
+*             Base64 constructor makes a defensive copy of the line separator array. Thanks to Gary Gregory.
+*             Base64 constructor makes a defensive copy of a custom alphabet array. Thanks to Gary Gregory.
+
+Changes
+-------
+
+*             Bump org.apache.commons:commons-parent from 66 to 69 #250, #261. Thanks to Dependabot, Gary Gregory.
+*             Bump commons-io:commons-io from 2.15.1 to 2.16.1 #258, #265. Thanks to Dependabot, Gary Gregory.
+
+
+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.16.1 RELEASE NOTES
 -----------------------------------------
 

diff --git a/src/changes/changes.xml b/src/changes/changes.xml
@@ -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.0" date="YYYY-MM-DD" description="Feature and fix release. Requires a minimum of Java 8.">
+    <release version="1.17.0" date="2024-04-20" description="Feature and fix release. Requires a minimum of Java 8.">
       <!-- FIX -->
       <action type="fix" issue="CODEC-320" dev="ggregory" due-to="Martin Frydl, Gary Gregory">Wrong output of DoubleMetaphone in 1.16.1.</action>
       <action type="fix" dev="ggregory" due-to="Gary Gregory">Optimize memory allocation in PhoneticEngine.</action>

diff --git a/src/site/xdoc/download_codec.xml b/src/site/xdoc/download_codec.xml
@@ -113,32 +113,32 @@ limitations under the License.
       </p>
     </subsection>
     </section>
-    <section name="Apache Commons Codec 1.16.1 ">
+    <section name="Apache Commons Codec 1.17.0 ">
       <subsection name="Binaries">
         <table>
           <tr>
-              <td><a href="[preferred]/commons/codec/binaries/commons-codec-1.16.1-bin.tar.gz">commons-codec-1.16.1-bin.tar.gz</a></td>
-              <td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.16.1-bin.tar.gz.sha512">sha512</a></td>
-              <td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.16.1-bin.tar.gz.asc">pgp</a></td>
+              <td><a href="[preferred]/commons/codec/binaries/commons-codec-1.17.0-bin.tar.gz">commons-codec-1.17.0-bin.tar.gz</a></td>
+              <td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.17.0-bin.tar.gz.sha512">sha512</a></td>
+              <td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.17.0-bin.tar.gz.asc">pgp</a></td>
           </tr>
           <tr>
-              <td><a href="[preferred]/commons/codec/binaries/commons-codec-1.16.1-bin.zip">commons-codec-1.16.1-bin.zip</a></td>
-              <td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.16.1-bin.zip.sha512">sha512</a></td>
-              <td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.16.1-bin.zip.asc">pgp</a></td>
+              <td><a href="[preferred]/commons/codec/binaries/commons-codec-1.17.0-bin.zip">commons-codec-1.17.0-bin.zip</a></td>
+              <td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.17.0-bin.zip.sha512">sha512</a></td>
+              <td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.17.0-bin.zip.asc">pgp</a></td>
           </tr>
         </table>
       </subsection>
       <subsection name="Source">
         <table>
           <tr>
-              <td><a href="[preferred]/commons/codec/source/commons-codec-1.16.1-src.tar.gz">commons-codec-1.16.1-src.tar.gz</a></td>
-              <td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.16.1-src.tar.gz.sha512">sha512</a></td>
-              <td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.16.1-src.tar.gz.asc">pgp</a></td>
+              <td><a href="[preferred]/commons/codec/source/commons-codec-1.17.0-src.tar.gz">commons-codec-1.17.0-src.tar.gz</a></td>
+              <td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.17.0-src.tar.gz.sha512">sha512</a></td>
+              <td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.17.0-src.tar.gz.asc">pgp</a></td>
           </tr>
           <tr>
-              <td><a href="[preferred]/commons/codec/source/commons-codec-1.16.1-src.zip">commons-codec-1.16.1-src.zip</a></td>
-              <td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.16.1-src.zip.sha512">sha512</a></td>
-              <td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.16.1-src.zip.asc">pgp</a></td>
+              <td><a href="[preferred]/commons/codec/source/commons-codec-1.17.0-src.zip">commons-codec-1.17.0-src.zip</a></td>
+              <td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.17.0-src.zip.sha512">sha512</a></td>
+              <td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.17.0-src.zip.asc">pgp</a></td>
           </tr>
         </table>
       </subsection>