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-cli.git
commit 595c54bd747c2f80447e0b4475c063f2e7ee7a7c Author: Gary Gregory <[email protected]> AuthorDate: Sat Aug 10 13:00:41 2024 +0000 Prepare for the next release candidate --- CONTRIBUTING.md | 9 ++++----- README.md | 12 +++++++----- RELEASE-NOTES.txt | 42 ++++++++++++++++++++++++++++++++++++++++++ src/changes/changes.xml | 2 +- src/site/xdoc/download_cli.xml | 26 +++++++++++++------------- 5 files changed, 67 insertions(+), 24 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a3ab78c..1282796 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,9 +41,8 @@ Contributing to Apache Commons CLI ====================== -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. `CLI-123-InputStream`. + * A good topic branch name can be the JIRA bug ID plus a keyword, e.g. `CLI-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 925fb7b..66ed382 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ Apache Commons CLI [](https://github.com/apache/commons-cli/actions/workflows/maven.yml) [](https://maven-badges.herokuapp.com/maven-central/commons-cli/commons-cli/?gav=true) -[](https://javadoc.io/doc/commons-cli/commons-cli/1.8.0) +[](https://javadoc.io/doc/commons-cli/commons-cli/1.9.0) [](https://github.com/apache/commons-cli/actions/workflows/codeql-analysis.yml) [](https://api.securityscorecards.dev/projects/github.com/apache/commons-cli) @@ -62,20 +62,20 @@ Getting the latest release -------------------------- You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-cli/download_cli.cgi). -Alternatively, you can pull it from the central Maven repositories: +Alternatively, you can pull it from the central Maven repositories: ```xml <dependency> <groupId>commons-cli</groupId> <artifactId>commons-cli</artifactId> - <version>1.8.0</version> + <version>1.9.0</version> </dependency> ``` Building -------- -Building requires a Java JDK and [Apache Maven](https://maven.apache.org/). +Building requires a Java JDK and [Apache Maven](https://maven.apache.org/). The required Java version is found in the `pom.xml` as the `maven.compiler.source` property. From a command shell, run `mvn` without arguments to invoke the default Maven goal to run all tests and checks. @@ -88,7 +88,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 df3f445..1f6dd18 100644 --- a/RELEASE-NOTES.txt +++ b/RELEASE-NOTES.txt @@ -1,3 +1,45 @@ +Apache Commons CLI Version 1.9.0 Release Notes + +Apache Commons CLI provides a simple API for presenting, processing, and validating a Command Line Interface. + +This release contains new features and bug fixes and requires Java 8 or above. + + +New Features +------------ + +* Add OptionGroup.isSelected(). Thanks to Gary Gregory. +* You can now extend HelpFormatter.Builder. Thanks to Gary Gregory. +* Add 'since' attribute to Option to track when an Option was introduced #292 Thanks to Claude Warren. + +Fixed Bugs +---------- + +* CLI-334: Fix Javadoc pathing #280. Thanks to Eric Pugh. +* CLI-335: Updated properties documentation #285. Thanks to Claude Warren. +* CLI-336: Deprecation not always reported #284. Thanks to Claude Warren, Gary Gregory. +* Replace internal StringBuffer with StringBuilder. Thanks to Gary Gregory. + +Updates +------- + +* Bump org.apache.commons:commons-parent from 70 to 72 #283. Thanks to Gary Gregory, Dependabot. + + +Historical list of changes: https://commons.apache.org/proper/commons-cli/changes-report.html + +For complete information on Apache Commons CLI, including instructions on how to submit bug reports, +patches, or suggestions for improvement, see the Apache Commons CLI website: + +https://commons.apache.org/proper/commons-cli/ + +Download page: https://commons.apache.org/proper/commons-cli/download_cli.cgi + +Have fun! +The Apache Commons Team + +------------------------------------------------------------------------------ + Apache Commons CLI Version 1.8.0 Release Notes Apache Commons CLI provides a simple API for presenting, processing, and validating a Command Line Interface. diff --git a/src/changes/changes.xml b/src/changes/changes.xml index 87097df..d66ec18 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -22,7 +22,7 @@ <title>Apache Commons CLI Release Notes</title> </properties> <body> - <release version="1.9.0" date="YYYY-MM-DD" description="This release contains new features and bug fixes and requires Java 8 or above."> + <release version="1.9.0" date="2024-08-10" description="This release contains new features and bug fixes and requires Java 8 or above."> <!-- ADD --> <action type="add" dev="ggregory" due-to="Gary Gregory">Add OptionGroup.isSelected().</action> <action type="add" dev="ggregory" due-to="Gary Gregory">You can now extend HelpFormatter.Builder.</action> diff --git a/src/site/xdoc/download_cli.xml b/src/site/xdoc/download_cli.xml index 71ab343..6deebf8 100644 --- a/src/site/xdoc/download_cli.xml +++ b/src/site/xdoc/download_cli.xml @@ -113,32 +113,32 @@ limitations under the License. </p> </subsection> </section> - <section name="Apache Commons CLI 1.8.0 "> + <section name="Apache Commons CLI 1.9.0 "> <subsection name="Binaries"> <table> <tr> - <td><a href="[preferred]/commons/cli/binaries/commons-cli-1.8.0-bin.tar.gz">commons-cli-1.8.0-bin.tar.gz</a></td> - <td><a href="https://downloads.apache.org/commons/cli/binaries/commons-cli-1.8.0-bin.tar.gz.sha512";>sha512</a></td> - <td><a href="https://downloads.apache.org/commons/cli/binaries/commons-cli-1.8.0-bin.tar.gz.asc";>pgp</a></td> + <td><a href="[preferred]/commons/cli/binaries/commons-cli-1.9.0-bin.tar.gz">commons-cli-1.9.0-bin.tar.gz</a></td> + <td><a href="https://downloads.apache.org/commons/cli/binaries/commons-cli-1.9.0-bin.tar.gz.sha512";>sha512</a></td> + <td><a href="https://downloads.apache.org/commons/cli/binaries/commons-cli-1.9.0-bin.tar.gz.asc";>pgp</a></td> </tr> <tr> - <td><a href="[preferred]/commons/cli/binaries/commons-cli-1.8.0-bin.zip">commons-cli-1.8.0-bin.zip</a></td> - <td><a href="https://downloads.apache.org/commons/cli/binaries/commons-cli-1.8.0-bin.zip.sha512";>sha512</a></td> - <td><a href="https://downloads.apache.org/commons/cli/binaries/commons-cli-1.8.0-bin.zip.asc";>pgp</a></td> + <td><a href="[preferred]/commons/cli/binaries/commons-cli-1.9.0-bin.zip">commons-cli-1.9.0-bin.zip</a></td> + <td><a href="https://downloads.apache.org/commons/cli/binaries/commons-cli-1.9.0-bin.zip.sha512";>sha512</a></td> + <td><a href="https://downloads.apache.org/commons/cli/binaries/commons-cli-1.9.0-bin.zip.asc";>pgp</a></td> </tr> </table> </subsection> <subsection name="Source"> <table> <tr> - <td><a href="[preferred]/commons/cli/source/commons-cli-1.8.0-src.tar.gz">commons-cli-1.8.0-src.tar.gz</a></td> - <td><a href="https://downloads.apache.org/commons/cli/source/commons-cli-1.8.0-src.tar.gz.sha512";>sha512</a></td> - <td><a href="https://downloads.apache.org/commons/cli/source/commons-cli-1.8.0-src.tar.gz.asc";>pgp</a></td> + <td><a href="[preferred]/commons/cli/source/commons-cli-1.9.0-src.tar.gz">commons-cli-1.9.0-src.tar.gz</a></td> + <td><a href="https://downloads.apache.org/commons/cli/source/commons-cli-1.9.0-src.tar.gz.sha512";>sha512</a></td> + <td><a href="https://downloads.apache.org/commons/cli/source/commons-cli-1.9.0-src.tar.gz.asc";>pgp</a></td> </tr> <tr> - <td><a href="[preferred]/commons/cli/source/commons-cli-1.8.0-src.zip">commons-cli-1.8.0-src.zip</a></td> - <td><a href="https://downloads.apache.org/commons/cli/source/commons-cli-1.8.0-src.zip.sha512";>sha512</a></td> - <td><a href="https://downloads.apache.org/commons/cli/source/commons-cli-1.8.0-src.zip.asc";>pgp</a></td> + <td><a href="[preferred]/commons/cli/source/commons-cli-1.9.0-src.zip">commons-cli-1.9.0-src.zip</a></td> + <td><a href="https://downloads.apache.org/commons/cli/source/commons-cli-1.9.0-src.zip.sha512";>sha512</a></td> + <td><a href="https://downloads.apache.org/commons/cli/source/commons-cli-1.9.0-src.zip.asc";>pgp</a></td> </tr> </table> </subsection>
