Skip to content

Commit 0c63e18

Browse files
garydgregorygarydgregory
committed
Prepare for the next release candidate
1 parent 86ef922 commit 0c63e18

File tree

5 files changed

+58
-23
lines changed

5 files changed

+58
-23
lines changed

‎CONTRIBUTING.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,8 @@
4141
Contributing to Apache Commons Codec
4242
======================
4343

44-
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
45-
the open source community. Before you dig right into the code there are a few guidelines that we need contributors to
46-
follow so that we can have a chance of keeping on top of things.
44+
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.
45+
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.
4746

4847
Getting Started
4948
---------------
@@ -62,7 +61,7 @@ Making Changes
6261

6362
+ Create a _topic branch_ for your isolated work.
6463
* Usually you should base your branch on the `master` branch.
65-
* A good topic branch name can be the JIRA bug id plus a keyword, e.g. `CODEC-123-InputStream`.
64+
* A good topic branch name can be the JIRA bug ID plus a keyword, e.g. `CODEC-123-InputStream`.
6665
* If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests.
6766
+ Make commits of logical units.
6867
* 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
7271
+ 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.
7372
+ Check for unnecessary whitespace with `git diff` -- check before committing.
7473
+ Make sure you have added the necessary tests for your changes, typically in `src/test/java`.
75-
+ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken.
74+
+ Run all the tests with `mvn clean verify` to ensure nothing else was accidentally broken.
7675

7776
Making Trivial Changes
7877
----------------------

‎README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ 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://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)
48-
[![Javadocs](https://javadoc.io/badge/commons-codec/commons-codec/1.17.0.svg)](https://javadoc.io/doc/commons-codec/commons-codec/1.17.0)
48+
[![Javadocs](https://javadoc.io/badge/commons-codec/commons-codec/1.17.1.svg)](https://javadoc.io/doc/commons-codec/commons-codec/1.17.1)
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

52-
The Apache Commons Codec component contains encoder and decoders for
52+
The Apache Commons Codec component contains encoders and decoders for
5353
various formats such as Base16, Base32, Base64, digest, and Hexadecimal. In addition to these
5454
widely used encoders and decoders, the codec package also maintains a
5555
collection of phonetic encoding utilities.
@@ -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.17.0</version>
74+
<version>1.17.1</version>
7575
</dependency>
7676
```
7777

@@ -91,7 +91,9 @@ There are some guidelines which will make applying PRs easier for us:
9191
+ No tabs! Please use spaces for indentation.
9292
+ Respect the existing code style for each file.
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.
94-
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn```.
94+
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running `mvn`.
95+
+ 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`
9597

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

‎RELEASE-NOTES.txt

+34
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,37 @@
1+
Apache Commons Codec 1.17.1 RELEASE NOTES
2+
-----------------------------------------
3+
4+
The Apache Commons Codec component contains encoders and decoders for
5+
various formats such as Base16, Base32, Base64, digest, and Hexadecimal. In addition to these
6+
widely used encoders and decoders, the codec package also maintains a
7+
collection of phonetic encoding utilities.
8+
9+
Feature and fix release. Requires a minimum of Java 8.
10+
11+
12+
13+
Fixed Bugs
14+
----------
15+
16+
* Md5Crypt now throws IllegalArgumentException on an invalid prefix. Thanks to Gary Gregory.
17+
18+
Changes
19+
-------
20+
21+
* Bump org.apache.commons:commons-parent from 69 to 71 #286. Thanks to Gary Gregory.
22+
* Bump org.codehaus.mojo:animal-sniffer-maven-plugin from 1.23 to 1.24 #293. Thanks to Dependabot.
23+
* Bump org.codehaus.mojo:taglist-maven-plugin from 3.0.0 to 3.1.0 #292. Thanks to Dependabot.
24+
25+
26+
For complete information on Apache Commons Codec, including instructions on how to submit bug reports,
27+
patches, or suggestions for improvement, see the Apache Commons Codec website:
28+
29+
https://commons.apache.org/proper/commons-codec/
30+
31+
Download page: https://commons.apache.org/proper/commons-codec/download_codec.cgi
32+
33+
---------------------------------------------------------------------------------
34+
135
Apache Commons Codec 1.17.0 RELEASE NOTES
236
-----------------------------------------
337

‎src/changes/changes.xml

+1-1
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.17.1" date="YYYY-MM-DD" description="Feature and fix release. Requires a minimum of Java 8.">
46+
<release version="1.17.1" date="2024-07-12" description="Feature and fix release. Requires a minimum of Java 8.">
4747
<!-- FIX -->
4848
<action type="fix" dev="ggregory" due-to="Gary Gregory">Md5Crypt now throws IllegalArgumentException on an invalid prefix.</action>
4949
<!-- ADD -->

‎src/site/xdoc/download_codec.xml

+13-13
Original file line numberDiff line numberDiff line change
@@ -113,32 +113,32 @@ limitations under the License.
113113
</p>
114114
</subsection>
115115
</section>
116-
<section name="Apache Commons Codec 1.17.0 ">
116+
<section name="Apache Commons Codec 1.17.1 ">
117117
<subsection name="Binaries">
118118
<table>
119119
<tr>
120-
<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>
121-
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.17.0-bin.tar.gz.sha512">sha512</a></td>
122-
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.17.0-bin.tar.gz.asc">pgp</a></td>
120+
<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>
121+
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.17.1-bin.tar.gz.sha512">sha512</a></td>
122+
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.17.1-bin.tar.gz.asc">pgp</a></td>
123123
</tr>
124124
<tr>
125-
<td><a href="[preferred]/commons/codec/binaries/commons-codec-1.17.0-bin.zip">commons-codec-1.17.0-bin.zip</a></td>
126-
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.17.0-bin.zip.sha512">sha512</a></td>
127-
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.17.0-bin.zip.asc">pgp</a></td>
125+
<td><a href="[preferred]/commons/codec/binaries/commons-codec-1.17.1-bin.zip">commons-codec-1.17.1-bin.zip</a></td>
126+
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.17.1-bin.zip.sha512">sha512</a></td>
127+
<td><a href="https://downloads.apache.org/commons/codec/binaries/commons-codec-1.17.1-bin.zip.asc">pgp</a></td>
128128
</tr>
129129
</table>
130130
</subsection>
131131
<subsection name="Source">
132132
<table>
133133
<tr>
134-
<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>
135-
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.17.0-src.tar.gz.sha512">sha512</a></td>
136-
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.17.0-src.tar.gz.asc">pgp</a></td>
134+
<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>
135+
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.17.1-src.tar.gz.sha512">sha512</a></td>
136+
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.17.1-src.tar.gz.asc">pgp</a></td>
137137
</tr>
138138
<tr>
139-
<td><a href="[preferred]/commons/codec/source/commons-codec-1.17.0-src.zip">commons-codec-1.17.0-src.zip</a></td>
140-
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.17.0-src.zip.sha512">sha512</a></td>
141-
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.17.0-src.zip.asc">pgp</a></td>
139+
<td><a href="[preferred]/commons/codec/source/commons-codec-1.17.1-src.zip">commons-codec-1.17.1-src.zip</a></td>
140+
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.17.1-src.zip.sha512">sha512</a></td>
141+
<td><a href="https://downloads.apache.org/commons/codec/source/commons-codec-1.17.1-src.zip.asc">pgp</a></td>
142142
</tr>
143143
</table>
144144
</subsection>

0 commit comments

Comments
 (0)