This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-codec.git
The following commit(s) were added to refs/heads/master by this push:
new 0c63e18b Prepare for the next release candidate
new 0d99b46f Merge branch 'master' of
https://gitbox.apache.org/repos/asf/commons-codec
0c63e18b is described below
commit 0c63e18b8a5e5b9b0195a632d136c85c1452b34f
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Fri Jul 12 16:13:10 2024 +0000
Prepare for the next release candidate
---
CONTRIBUTING.md | 9 ++++-----
README.md | 10 ++++++----
RELEASE-NOTES.txt | 34 ++++++++++++++++++++++++++++++++++
src/changes/changes.xml | 2 +-
src/site/xdoc/download_codec.xml | 26 +++++++++++++-------------
5 files changed, 58 insertions(+), 23 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 62e99f8d..d4e74f74 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -41,9 +41,8 @@
Contributing to Apache Commons Codec
======================
-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.
`CODEC-123-InputStream`.
+ * A good topic branch name can be the JIRA bug ID plus a keyword, e.g.
`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.
@@ -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 21e88e3d..d5750ab8 100644
--- a/README.md
+++ b/README.md
@@ -45,11 +45,11 @@ Apache Commons Codec
[](https://github.com/apache/commons-codec/actions/workflows/maven.yml)
[](https://maven-badges.herokuapp.com/maven-central/commons-codec/commons-codec/?gav=true)
-[](https://javadoc.io/doc/commons-codec/commons-codec/1.17.0)
+[](https://javadoc.io/doc/commons-codec/commons-codec/1.17.1)
[](https://github.com/apache/commons-codec/actions/workflows/codeql-analysis.yml)
[](https://api.securityscorecards.dev/projects/github.com/apache/commons-codec)
-The Apache Commons Codec component contains encoder and decoders for
+The Apache Commons Codec component contains encoders 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.
@@ -71,7 +71,7 @@ Alternatively, you can pull it from the central Maven
repositories:
<dependency>
<groupId>commons-codec</groupId>
<artifactId>commons-codec</artifactId>
- <version>1.17.0</version>
+ <version>1.17.1</version>
</dependency>
```
@@ -91,7 +91,9 @@ There are some guidelines which will make applying PRs easier
for us:
+ No tabs! Please use spaces for indentation.
+ Respect the existing code style for each file.
+ 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.
-+ Provide JUnit tests for your changes and make sure your changes don't break
any existing tests by running ```mvn```.
++ Provide JUnit tests for your changes and make sure your changes don't break
any existing tests by running `mvn`.
++ Before you pushing a PR, run `mvn` (by itself), this runs the default goal,
which contains all build checks.
++ To see the code coverage report, regardless of coverage failures, run `mvn
clean site -Dcommons.jacoco.haltOnFailure=false`
If you plan to contribute on a regular basis, please consider filing a
[contributor license agreement](https://www.apache.org/licenses/#clas).
You can learn more about contributing via GitHub in our [contribution
guidelines](CONTRIBUTING.md).
diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt
index 920aa617..57ee97eb 100644
--- a/RELEASE-NOTES.txt
+++ b/RELEASE-NOTES.txt
@@ -1,3 +1,37 @@
+Apache Commons Codec 1.17.1 RELEASE NOTES
+-----------------------------------------
+
+The Apache Commons Codec component contains encoders 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.
+
+
+
+Fixed Bugs
+----------
+
+* Md5Crypt now throws IllegalArgumentException on an invalid
prefix. Thanks to Gary Gregory.
+
+Changes
+-------
+
+* Bump org.apache.commons:commons-parent from 69 to 71 #286.
Thanks to Gary Gregory.
+* Bump org.codehaus.mojo:animal-sniffer-maven-plugin from 1.23 to
1.24 #293. Thanks to Dependabot.
+* Bump org.codehaus.mojo:taglist-maven-plugin from 3.0.0 to 3.1.0
#292. Thanks to 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.0 RELEASE NOTES
-----------------------------------------
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index cec12326..8c2a9ed1 100644
--- 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.1" date="YYYY-MM-DD" description="Feature and fix
release. Requires a minimum of Java 8.">
+ <release version="1.17.1" date="2024-07-12" description="Feature and fix
release. Requires a minimum of Java 8.">
<!-- FIX -->
<action type="fix" dev="ggregory" due-to="Gary Gregory">Md5Crypt now
throws IllegalArgumentException on an invalid prefix.</action>
<!-- ADD -->
diff --git a/src/site/xdoc/download_codec.xml b/src/site/xdoc/download_codec.xml
index 21317e59..ad484142 100644
--- 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.17.0 ">
+ <section name="Apache Commons Codec 1.17.1 ">
<subsection name="Binaries">
<table>
<tr>
- <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>
+ <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>
</tr>
<tr>
- <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>
+ <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>
</tr>
</table>
</subsection>
<subsection name="Source">
<table>
<tr>
- <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>
+ <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>
</tr>
<tr>
- <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>
+ <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>
</tr>
</table>
</subsection>
