Skip to content

Commit e17fee4

Browse files
garydgregorygarydgregory
committed
Prepare for the next release candidate
1 parent 274488c commit e17fee4

7 files changed

Lines changed: 336 additions & 255 deletions

File tree

‎README.md‎

Lines changed: 117 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -1,106 +1,119 @@
1-
<!---
2-
Licensed to the Apache Software Foundation (ASF) under one or more
3-
contributor license agreements. See the NOTICE file distributed with
4-
this work for additional information regarding copyright ownership.
5-
The ASF licenses this file to You under the Apache License, Version 2.0
6-
(the "License"); you may not use this file except in compliance with
7-
the License. You may obtain a copy of the License at
8-
9-
http://www.apache.org/licenses/LICENSE-2.0
10-
11-
Unless required by applicable law or agreed to in writing, software
12-
distributed under the License is distributed on an "AS IS" BASIS,
13-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14-
See the License for the specific language governing permissions and
15-
limitations under the License.
16-
-->
17-
<!---
18-
+======================================================================+
19-
|**** ****|
20-
|**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
21-
|**** DO NOT EDIT DIRECTLY ****|
22-
|**** ****|
23-
+======================================================================+
24-
| TEMPLATE FILE: readme-md-template.md |
25-
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
26-
+======================================================================+
27-
| |
28-
| 1) Re-generate using: mvn commons-build:readme-md |
29-
| |
30-
| 2) Set the following properties in the component's pom: |
31-
| - commons.componentid (required, alphabetic, lower case) |
32-
| - commons.release.version (required) |
33-
| |
34-
| 3) Example Properties |
35-
| |
36-
| <properties> |
37-
| <commons.componentid>math</commons.componentid> |
38-
| <commons.release.version>1.2</commons.release.version> |
39-
| </properties> |
40-
| |
41-
+======================================================================+
42-
--->
43-
Apache Commons CLI
44-
===================
45-
1+
<!---
2+
Licensed to the Apache Software Foundation (ASF) under one or more
3+
contributor license agreements. See the NOTICE file distributed with
4+
this work for additional information regarding copyright ownership.
5+
The ASF licenses this file to You under the Apache License, Version 2.0
6+
(the "License"); you may not use this file except in compliance with
7+
the License. You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
-->
17+
<!---
18+
+======================================================================+
19+
|**** ****|
20+
|**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
21+
|**** DO NOT EDIT DIRECTLY ****|
22+
|**** ****|
23+
+======================================================================+
24+
| TEMPLATE FILE: readme-md-template.md |
25+
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
26+
+======================================================================+
27+
| |
28+
| 1) Re-generate using: mvn commons-build:readme-md |
29+
| |
30+
| 2) Set the following properties in the component's pom: |
31+
| - commons.componentid (required, alphabetic, lower case) |
32+
| - commons.release.version (required) |
33+
| |
34+
| 3) Example Properties |
35+
| |
36+
| <properties> |
37+
| <commons.componentid>math</commons.componentid> |
38+
| <commons.release.version>1.2</commons.release.version> |
39+
| </properties> |
40+
| |
41+
+======================================================================+
42+
--->
43+
Apache Commons CLI
44+
===================
45+
4646
[![Java CI](https://github.com/apache/commons-cli/actions/workflows/maven.yml/badge.svg)](https://github.com/apache/commons-cli/actions/workflows/maven.yml)
47-
[![Coverage Status](https://codecov.io/gh/apache/commons-cli/branch/master/graph/badge.svg)](https://app.codecov.io/gh/apache/commons-cli/branch/master)
48-
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/commons-cli/commons-cli/badge.svg?gav=true)](https://maven-badges.herokuapp.com/maven-central/commons-cli/commons-cli/?gav=true)
49-
[![Javadocs](https://javadoc.io/badge/commons-cli/commons-cli/1.5.0.svg)](https://javadoc.io/doc/commons-cli/commons-cli/1.5.0)
47+
[![Coverage Status](https://codecov.io/gh/apache/commons-cli/branch/master/graph/badge.svg)](https://app.codecov.io/gh/apache/commons-cli)
48+
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/commons-cli/commons-cli/badge.svg?gav=true)](https://maven-badges.herokuapp.com/maven-central/commons-cli/commons-cli/?gav=true)
49+
[![Javadocs](https://javadoc.io/badge/commons-cli/commons-cli/1.6.0.svg)](https://javadoc.io/doc/commons-cli/commons-cli/1.6.0)
5050
[![CodeQL](https://github.com/apache/commons-cli/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/apache/commons-cli/actions/workflows/codeql-analysis.yml)
51-
52-
Apache Commons CLI provides a simple API for presenting, processing and validating a Command Line Interface.
53-
54-
Documentation
55-
-------------
56-
57-
More information can be found on the [Apache Commons CLI homepage](https://commons.apache.org/proper/commons-cli).
58-
The [Javadoc](https://commons.apache.org/proper/commons-cli/apidocs) can be browsed.
59-
Questions related to the usage of Apache Commons CLI should be posted to the [user mailing list][ml].
60-
61-
Where can I get the latest release?
62-
-----------------------------------
63-
You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-cli/download_cli.cgi).
64-
65-
Alternatively, you can pull it from the central Maven repositories:
66-
67-
```xml
68-
<dependency>
69-
<groupId>commons-cli</groupId>
70-
<artifactId>commons-cli</artifactId>
71-
<version>1.5.0</version>
72-
</dependency>
73-
```
74-
75-
Contributing
76-
------------
77-
78-
We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors.
79-
There are some guidelines which will make applying PRs easier for us:
80-
+ No tabs! Please use spaces for indentation.
81-
+ Respect the code style.
82-
+ 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.
83-
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn```.
84-
85-
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
86-
You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
87-
88-
License
89-
-------
90-
This code is under the [Apache License v2](https://www.apache.org/licenses/LICENSE-2.0).
91-
92-
See the `NOTICE.txt` file for required notices and attributions.
93-
94-
Donations
95-
---------
96-
You like Apache Commons CLI? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
97-
98-
Additional Resources
99-
--------------------
100-
101-
+ [Apache Commons Homepage](https://commons.apache.org/)
102-
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/CLI)
103-
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
104-
+ `#apache-commons` IRC channel on `irc.freenode.org`
105-
106-
[ml]:https://commons.apache.org/mail-lists.html
51+
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/apache/commons-cli/badge)](https://api.securityscorecards.dev/projects/github.com/apache/commons-cli)
52+
53+
Apache Commons CLI provides a simple API for presenting, processing and validating a Command Line Interface.
54+
55+
Documentation
56+
-------------
57+
58+
More information can be found on the [Apache Commons CLI homepage](https://commons.apache.org/proper/commons-cli).
59+
The [Javadoc](https://commons.apache.org/proper/commons-cli/apidocs) can be browsed.
60+
Questions related to the usage of Apache Commons CLI should be posted to the [user mailing list][ml].
61+
62+
Getting the latest release
63+
--------------------------
64+
You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-cli/download_cli.cgi).
65+
66+
Alternatively, you can pull it from the central Maven repositories:
67+
68+
```xml
69+
<dependency>
70+
<groupId>commons-cli</groupId>
71+
<artifactId>commons-cli</artifactId>
72+
<version>1.6.0</version>
73+
</dependency>
74+
```
75+
76+
Building
77+
--------
78+
79+
Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
80+
The required Java version is found in the `pom.xml` as the `maven.compiler.source` property.
81+
82+
From a command shell, run `mvn` without arguments to invoke the default Maven goal to run all tests and checks.
83+
84+
Contributing
85+
------------
86+
87+
We accept Pull Requests via GitHub. The [developer mailing list](https://commons.apache.org/mail-lists.html) is the main channel of communication for contributors.
88+
There are some guidelines which will make applying PRs easier for us:
89+
+ No tabs! Please use spaces for indentation.
90+
+ Respect the existing code style for each file.
91+
+ 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.
92+
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn```.
93+
94+
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
95+
You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
96+
97+
License
98+
-------
99+
This code is licensed under the [Apache License v2](https://www.apache.org/licenses/LICENSE-2.0).
100+
101+
See the `NOTICE.txt` file for required notices and attributions.
102+
103+
Donating
104+
--------
105+
You like Apache Commons CLI? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support development.
106+
107+
Additional Resources
108+
--------------------
109+
110+
+ [Apache Commons Homepage](https://commons.apache.org/)
111+
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/CLI)
112+
+ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
113+
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
114+
+ `#apache-commons` IRC channel on `irc.freenode.org`
115+
116+
Apache Commons Components
117+
-------------------------
118+
119+
Please see the [list of components](https://commons.apache.org/components.html)

‎RELEASE-NOTES.txt‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,72 @@
1+
Apache Commons CLI
2+
Version 1.6.0
3+
Release Notes
4+
5+
6+
This document contains the release notes for this version of the Apache Commons
7+
CLI Component of the Apache Commons Project. Commons CLI provides a simple API
8+
for working with the command line arguments and options.
9+
10+
Apache Commons CLI provides a simple API for presenting, processing and validating a Command Line Interface.
11+
12+
New features and bug fixes
13+
14+
Changes in this version include:
15+
16+
17+
Fixed Bugs
18+
==========
19+
20+
o [StepSecurity] ci: Harden GitHub Actions #176. Thanks to step-security-bot, Gary Gregory.
21+
o CLI-318: Inconsistent date format in changes report. Thanks to Alexander Veit, Gary Gregory.
22+
o CLI-283: Fix NPE in CommandLine.resolveOption(String). Thanks to Dilraj Singh, Gary Gregory.
23+
o CLI-283: CommandLine.addOption(Option) should not allow a null Option. Thanks to Dilraj Singh, Gary Gregory.
24+
o CLI-283: CommandLine.addArgs(String) should not allow a null String. Thanks to Gary Gregory.
25+
o CLI-303: Site docs: "Usage Scenarios" refers to deprecated methods. Thanks to Julian Schilling, Gary Gregory.
26+
o CLI-317: NullPointerException thrown by CommandLineParser.parse(). Thanks to Philippe Bastiani, Sruteesh Kumar Paramata, Gary Gregory.
27+
o CLI-313: StringIndexOutOfBoundsException thrown by CommandLineParser.parse(). Thanks to Dominik Stadler, HUNG LU, Sruteesh Kumar Paramata.
28+
29+
Updates
30+
=======
31+
32+
o Fix SpotBugs Error: Medium: Method intentionally throws RuntimeException. [org.apache.commons.cli.Option] At Option.java:[lines 417-423] THROWS_METHOD_THROWS_RUNTIMEEXCEPTION Thanks to Gary Gregory.
33+
o Fix SpotBugs Error: Medium: Method intentionally throws RuntimeException. [org.apache.commons.cli.Option] At Option.java:[lines 446-450] THROWS_METHOD_THROWS_RUNTIMEEXCEPTION Thanks to Gary Gregory.
34+
o Fix SpotBugs Error: Medium: Method intentionally throws RuntimeException. [org.apache.commons.cli.Option] At Option.java:[lines 474-478] THROWS_METHOD_THROWS_RUNTIMEEXCEPTION Thanks to Gary Gregory.
35+
o Use EMPTY_STRING_ARRAY constant. #102. Thanks to Ken Dombeck.
36+
o Fix site links that are broken #155. Thanks to Arturo Bernal.
37+
o Use Math.max() #111.
38+
Delete unused assignment #112. Thanks to Arturo Bernal.
39+
o Add github/codeql-action. Thanks to Dependabot, Gary Gregory.
40+
o Bump Java from 7 to 8. Thanks to Gary Gregory.
41+
o Bump actions/cache from 2.1.7 to 3.0.10 #97, #130, #132. Thanks to Dependabot, Gary Gregory.
42+
o Bump actions/checkout from 3 to 3.1.0 #133. Thanks to Gary Gregory, Dependabot.
43+
o Bump actions/setup-java from 2 to 3.6.0 #136. Thanks to Gary Gregory.
44+
o Bump spotbugs from 4.5.3 to 4.7.3 #96, #107, #113, #125, #138. Thanks to Gary Gregory, Dependabot.
45+
o Bump spotbugs-maven-plugin from 4.5.3.0 to 4.7.3.0 #98, #108, #115, #117, #126, #145. Thanks to Dependabot.
46+
o Bump commons-parent from 52 to 64 #100, #128, #151, #158. Thanks to Dependabot, Gary Gregory.
47+
o Bump maven-antrun-plugin from 3.0.0 to 3.1.0 #103. Thanks to Dependabot.
48+
o Bump maven-javadoc-plugin from 3.3.2 to 3.4.1 #105, #120. Thanks to Dependabot.
49+
o Bump maven-pmd-plugin from 3.16.0 to 3.19.0 #110, #124. Thanks to Dependabot.
50+
o Bump jacoco-maven-plugin from 0.8.7 to 0.8.8. Thanks to Gary Gregory.
51+
o Bump maven-checkstyle-plugin from 3.1.2 to 3.2.0 #121. Thanks to Gary Gregory.
52+
o Bump japicmp-maven-plugin from 0.15.4 to 0.16.0. Thanks to Gary Gregory.
53+
o Update JUnit 4 to 5 vintage. Thanks to Gary Gregory.
54+
55+
56+
Historical list of changes: https://commons.apache.org/proper/commons-cli/changes-report.html
57+
58+
For complete information on Apache Commons CLI, including instructions on how to submit bug reports,
59+
patches, or suggestions for improvement, see the Apache Commons CLI website:
60+
61+
https://commons.apache.org/proper/commons-cli/
62+
63+
Download page: https://commons.apache.org/proper/commons-cli/download_cli.cgi
64+
65+
Have fun!
66+
The Apache Commons Team
67+
68+
------------------------------------------------------------------------------
69+
170
Apache Commons CLI
271
Version 1.5.0
372
Release Notes

‎pom.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,7 @@
200200
<commons.componentid>cli</commons.componentid>
201201
<commons.module.name>org.apache.commons.cli</commons.module.name>
202202
<commons.release.version>1.6.0</commons.release.version>
203+
<commons.release.next>1.7.0</commons.release.next>
203204
<commons.release.name>commons-cli-${commons.release.version}</commons.release.name>
204205
<commons.release.isDistModule>true</commons.release.isDistModule>
205206
<commons.rc.version>RC1</commons.rc.version>

‎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.6.0" date="2023-MM-DD" description="New features and bug fixes">
25+
<release version="1.6.0" date="2023-10-23" description="New features and bug fixes">
2626
<!-- FIX -->
2727
<action type="update" dev="ggregory" due-to="Gary Gregory">
2828
Fix SpotBugs Error: Medium: Method intentionally throws RuntimeException. [org.apache.commons.cli.Option] At Option.java:[lines 417-423] THROWS_METHOD_THROWS_RUNTIMEEXCEPTION

0 commit comments

Comments
 (0)