Skip to content

Commit d9e46ab

Browse files
committed
Prepare for the next release candidate
1 parent 045ffbb commit d9e46ab

5 files changed

Lines changed: 72 additions & 7 deletions

File tree

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, `CLI-123-InputStream`.
64+
* A good topic branch name can be the JIRA bug ID plus a keyword, e.g. `CLI-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, `[CLI-123] Close input stream earlier`
68+
* For example, `[CLI-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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ There are some guidelines which will make applying PRs easier for us:
9090
+ 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.
9191
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running `mvn`.
9292
+ Before you pushing a PR, run `mvn` (by itself), this runs the default goal, which contains all build checks.
93-
+ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false`
93+
+ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false -Pjacoco`
9494

9595
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
9696
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 CLI 1.10.0 Release Notes
2+
------------------------------------------------
3+
4+
The Apache Commons CLI team is pleased to announce the release of Apache Commons CLI 1.10.0.
5+
6+
Apache Commons CLI provides a simple API for presenting, processing, and validating a Command Line Interface.
7+
8+
This is a feature and maintenance release. Java 8 or later is required.
9+
10+
11+
New Features
12+
------------
13+
14+
* CLI-339: Help formatter extension in the new package #314. Thanks to Claude Warren, Gary Gregory.
15+
* CommandLine.Builder implements Supplier<CommandLine>. Thanks to Gary Gregory.
16+
* DefaultParser.Builder implements Supplier<DefaultParser>. Thanks to Gary Gregory.
17+
* CLI-340: Add CommandLine.getParsedOptionValues() #334. Thanks to Claude Warren, Gary Gregory.
18+
* CLI-333: org.apache.commons.cli.Option.Builder implements Supplier<Option>. Thanks to Claude Warren, Gary Gregory.
19+
20+
Fixed Bugs
21+
----------
22+
23+
* Deprecate CommandLine.Builder() in favor of CommandLine.builder(). Thanks to Gary Gregory.
24+
* Deprecate DeprecatedAttributes.Builder() in favor of DeprecatedAttributes.builder(). Thanks to Gary Gregory.
25+
* Refactor default parser test #294. Thanks to Dávid Szigecsán.
26+
* Port to JUnit 5. Thanks to Gary Gregory.
27+
* Generics for Converter should use Exception not Throwable. Thanks to Gary Gregory.
28+
* Pick up maven-antrun-plugin version from parent POM org.apache:apache. Thanks to Gary Gregory.
29+
* Javadoc is missing its Overview page. Thanks to Gary Gregory.
30+
* Get mockito version from parent pom (#351). Thanks to Arnout Engelen.
31+
* 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.
32+
* Deprecate PatternOptionBuilder.PatternOptionBuilder(). Thanks to Arnout Engelen.
33+
* CLI-341: HelpFormatter infinite loop with 0 width input. Thanks to Ruiqi Dong, Gary Gregory.
34+
* CLI-349: Fail faster with a more precise NullPointerException: Option.processValue() throws NullPointerException when passed null value with value separator configured. Thanks to Leo Fernandes, Gary Gregory.
35+
* CLI-344: Fail faster with a more precise NullPointerException: DefaultParser.parse() throws NullPointerException when options parameter is null. Thanks to Ruiqi Dong, Gary Gregory.
36+
* CLI-347: Options.addOptionGroup(OptionGroup) does not remove required options from requiredOpts list. Thanks to Ruiqi Dong, Gary Gregory.
37+
* org.apache.commons.cli.Option.Builder.get() should throw IllegalStateException instead of IllegalArgumentException. Thanks to Gary Gregory.
38+
* org.apache.commons.cli.Option.processValue(String) should throw IllegalStateException instead of IllegalArgumentException. Thanks to Gary Gregory.
39+
* org.apache.commons.cli.OptionBuilder.create() should throw IllegalStateException instead of IllegalArgumentException. Thanks to Gary Gregory.
40+
41+
Updates
42+
-------
43+
44+
* Bump org.apache.commons:commons-parent from 72 to 85 #302, #304, #310, #315, #320, #327, #371. Thanks to Gary Gregory, Dependabot.
45+
* [test] Bump commons-io:commons-io from 2.16.1 to 2.20.0 #309, #337. Thanks to Gary Gregory, Dependabot.
46+
* [test] Bump org.apache.commons:commons-text from 1.12.0 to 1.14.0 #344. Thanks to Gary Gregory, Dependabot.
47+
* Update site documentation to https://maven.apache.org/xsd/xdoc-2.0.xsd. Thanks to Gary Gregory.
48+
49+
50+
Historical list of changes: https://commons.apache.org/proper/commons-cli/changes.html
51+
52+
For complete information on Apache Commons CLI, including instructions on how to submit bug reports,
53+
patches, or suggestions for improvement, see the Apache Commons CLI website:
54+
55+
https://commons.apache.org/proper/commons-cli/
56+
57+
Download page: https://commons.apache.org/proper/commons-cli/download_cli.cgi
58+
59+
Have fun!
60+
The Apache Commons Team
61+
62+
------------------------------------------------------------------------------
63+
164
Apache Commons CLI 1.10.0 Release Notes
265
---------------------------------------
366

src/changes/changes.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
<title>Apache Commons CLI Release Notes</title>
2323
</properties>
2424
<body>
25-
<release version="1.10.0" date="YYYY-MM-DD" description="This is a feature and maintenance release. Java 8 or later is required.">
25+
<release version="1.10.0" date="2025-07-30" description="This is a feature and maintenance release. Java 8 or later is required.">
2626
<!-- FIX -->
2727
<action type="fix" dev="ggregory" due-to="Gary Gregory">Deprecate CommandLine.Builder() in favor of CommandLine.builder().</action>
2828
<action type="fix" dev="ggregory" due-to="Gary Gregory">Deprecate DeprecatedAttributes.Builder() in favor of DeprecatedAttributes.builder().</action>

src/site/xdoc/download_cli.xml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,12 @@ limitations under the License.
5656
| |
5757
+======================================================================+
5858
-->
59-
<document>
59+
<document xmlns="http://maven.apache.org/XDOC/2.0"
60+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
61+
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
6062
<properties>
6163
<title>Download Apache Commons CLI</title>
62-
<author email="dev@commons.apache.org">Apache Commons Documentation Team</author>
64+
<author email="dev@commons.apache.org">Apache Commons Team</author>
6365
</properties>
6466
<body>
6567
<section name="Download Apache Commons CLI">
@@ -79,7 +81,7 @@ limitations under the License.
7981
mirrors (at the end of the mirrors list) that should be
8082
available.
8183
<br></br>
82-
[if-any logo]<a href="[link]"><img align="right" src="[logo]" border="0"></img></a>[end]
84+
[if-any logo]<a href="[link]"><img align="right" src="[logo]" border="0" alt="Logo"></img></a>[end]
8385
</p>
8486

8587
<form action="[location]" method="get" id="SelectMirror">

0 commit comments

Comments
 (0)