Prepare for the next release candidate
This commit is contained in:
Gary Gregory
parent
e9d466ecc5
commit
342547b911
|
|
@ -41,9 +41,8 @@
|
||||||
Contributing to Apache Commons CSV
|
Contributing to Apache Commons CSV
|
||||||
======================
|
======================
|
||||||
|
|
||||||
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
|
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.
|
||||||
the open source community. Before you dig right into the code there are a few guidelines that we need contributors to
|
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.
|
||||||
follow so that we can have a chance of keeping on top of things.
|
|
||||||
|
|
||||||
Getting Started
|
Getting Started
|
||||||
---------------
|
---------------
|
||||||
|
|
@ -62,7 +61,7 @@ Making Changes
|
||||||
|
|
||||||
+ Create a _topic branch_ for your isolated work.
|
+ Create a _topic branch_ for your isolated work.
|
||||||
* Usually you should base your branch on the `master` branch.
|
* 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. `CSV-123-InputStream`.
|
* A good topic branch name can be the JIRA bug ID plus a keyword, e.g. `CSV-123-InputStream`.
|
||||||
* If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests.
|
* If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests.
|
||||||
+ Make commits of logical units.
|
+ 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.
|
* 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.
|
+ 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.
|
+ 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`.
|
+ 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
|
Making Trivial Changes
|
||||||
----------------------
|
----------------------
|
||||||
|
|
|
||||||
|
|
@ -45,7 +45,7 @@ Apache Commons CSV
|
||||||
|
|
||||||
[](https://github.com/apache/commons-csv/actions/workflows/maven.yml)
|
[](https://github.com/apache/commons-csv/actions/workflows/maven.yml)
|
||||||
[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-csv/?gav=true)
|
[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-csv/?gav=true)
|
||||||
[](https://javadoc.io/doc/org.apache.commons/commons-csv/1.11.0)
|
[](https://javadoc.io/doc/org.apache.commons/commons-csv/1.12.0)
|
||||||
[](https://github.com/apache/commons-csv/actions/workflows/codeql-analysis.yml)
|
[](https://github.com/apache/commons-csv/actions/workflows/codeql-analysis.yml)
|
||||||
[](https://api.securityscorecards.dev/projects/github.com/apache/commons-csv)
|
[](https://api.securityscorecards.dev/projects/github.com/apache/commons-csv)
|
||||||
|
|
||||||
|
|
@ -68,7 +68,7 @@ Alternatively, you can pull it from the central Maven repositories:
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.apache.commons</groupId>
|
<groupId>org.apache.commons</groupId>
|
||||||
<artifactId>commons-csv</artifactId>
|
<artifactId>commons-csv</artifactId>
|
||||||
<version>1.11.0</version>
|
<version>1.12.0</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -88,7 +88,9 @@ There are some guidelines which will make applying PRs easier for us:
|
||||||
+ No tabs! Please use spaces for indentation.
|
+ No tabs! Please use spaces for indentation.
|
||||||
+ Respect the existing code style for each file.
|
+ 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.
|
+ 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).
|
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).
|
You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,61 @@
|
||||||
|
Apache Commons CSV
|
||||||
|
Version 1.12.0
|
||||||
|
Release Notes
|
||||||
|
|
||||||
|
This document contains the release notes for the 1.12.0 version of Apache Commons CSV.
|
||||||
|
Commons CSV reads and writes files in variations of the Comma Separated Value (CSV) format.
|
||||||
|
|
||||||
|
Commons CSV requires at least Java 8.
|
||||||
|
|
||||||
|
The Apache Commons CSV library provides a simple interface for reading and writing CSV files of various types.
|
||||||
|
|
||||||
|
Feature and bug fix release (Java 8 or above)
|
||||||
|
|
||||||
|
Changes in this version include:
|
||||||
|
|
||||||
|
New Features
|
||||||
|
------------
|
||||||
|
|
||||||
|
* CSV-270: Add CSVException that extends IOException thrown on invalid input instead of IOException. Thanks to Thomas Kamps, Gary Gregory.
|
||||||
|
|
||||||
|
Fixed Bugs
|
||||||
|
----------
|
||||||
|
|
||||||
|
* Fix PMD issues for port to PMD 7.1.0. Thanks to Gary Gregory.
|
||||||
|
* Fix some Javadoc links #442. Thanks to Dávid Szigecsán, Gary Gregory.
|
||||||
|
* Extract duplicated code into a method #444. Thanks to Dávid Szigecsán.
|
||||||
|
* Migrate CSVFormat#print(File, Charset) to NIO #445. Thanks to Dávid Szigecsán.
|
||||||
|
* Fix documentation for CSVFormat private constructor #466. Thanks to Dávid Szigecsán.
|
||||||
|
* CSV-294: CSVFormat does not support explicit " as escape char. Thanks to Joern Huxhorn, Gary Gregory.
|
||||||
|
* CSV-150: Escaping is not disableable. Thanks to dota17, Gary Gregory, Jörn Huxhorn.
|
||||||
|
* Fix Javadoc warnings on Java 23. Thanks to Gary Gregory.
|
||||||
|
* Improve parser performance by up to 20%, YMMV. Thanks to Gary Gregory.
|
||||||
|
|
||||||
|
Changes
|
||||||
|
-------
|
||||||
|
|
||||||
|
* Bump commons-codec:commons-codec from 1.16.1 to 1.17.1 #422, #449. Thanks to Dependabot.
|
||||||
|
* Bump org.apache.commons:commons-parent from 69 to 75 #435, #452, #465, #468, #475. Thanks to Gary Gregory.
|
||||||
|
* Bump org.codehaus.mojo:taglist-maven-plugin from 3.0.0 to 3.1.0 #441. Thanks to Gary Gregory.
|
||||||
|
* Bump org.apache.commons:commons-lang3 from 3.14.0 to 3.17.0 #450, #459, #470. Thanks to Gary Gregory.
|
||||||
|
* Bump org.hamcrest:hamcrest from 2.2 to 3.0 #455. Thanks to Gary Gregory.
|
||||||
|
* Bump commons-io:commons-io from 2.16.1 to 2.17.0 #476. Thanks to Gary Gregory, Dependabot.
|
||||||
|
|
||||||
|
|
||||||
|
Historical list of changes: https://commons.apache.org/proper/commons-csv/changes-report.html
|
||||||
|
|
||||||
|
For complete information on Apache Commons CSV, including instructions on how to submit bug reports,
|
||||||
|
patches, or suggestions for improvement, see the Apache Commons CSV website:
|
||||||
|
|
||||||
|
https://commons.apache.org/proper/commons-csv/
|
||||||
|
|
||||||
|
Download page: https://commons.apache.org/proper/commons-csv/download_csv.cgi
|
||||||
|
|
||||||
|
Have fun!
|
||||||
|
-Apache Commons CSV team
|
||||||
|
|
||||||
|
------------------------------------------------------------------------------
|
||||||
|
|
||||||
Apache Commons CSV Version 1.11.0
|
Apache Commons CSV Version 1.11.0
|
||||||
Release Notes
|
Release Notes
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -40,7 +40,7 @@
|
||||||
<title>Apache Commons CSV Release Notes</title>
|
<title>Apache Commons CSV Release Notes</title>
|
||||||
</properties>
|
</properties>
|
||||||
<body>
|
<body>
|
||||||
<release version="1.12.0" date="YYYY-MM-DD" description="Feature and bug fix release (Java 8 or above)">
|
<release version="1.12.0" date="2024-09-21" description="Feature and bug fix release (Java 8 or above)">
|
||||||
<!-- ADD -->
|
<!-- ADD -->
|
||||||
<action type="add" issue="CSV-270" dev="ggregory" due-to="Thomas Kamps, Gary Gregory">Add CSVException that extends IOException thrown on invalid input instead of IOException.</action>
|
<action type="add" issue="CSV-270" dev="ggregory" due-to="Thomas Kamps, Gary Gregory">Add CSVException that extends IOException thrown on invalid input instead of IOException.</action>
|
||||||
<!-- FIX -->
|
<!-- FIX -->
|
||||||
|
|
|
||||||
|
|
@ -113,32 +113,32 @@ limitations under the License.
|
||||||
</p>
|
</p>
|
||||||
</subsection>
|
</subsection>
|
||||||
</section>
|
</section>
|
||||||
<section name="Apache Commons CSV 1.11.0 (Java 8 or above)">
|
<section name="Apache Commons CSV 1.12.0 (Java 8 or above)">
|
||||||
<subsection name="Binaries">
|
<subsection name="Binaries">
|
||||||
<table>
|
<table>
|
||||||
<tr>
|
<tr>
|
||||||
<td><a href="[preferred]/commons/csv/binaries/commons-csv-1.11.0-bin.tar.gz">commons-csv-1.11.0-bin.tar.gz</a></td>
|
<td><a href="[preferred]/commons/csv/binaries/commons-csv-1.12.0-bin.tar.gz">commons-csv-1.12.0-bin.tar.gz</a></td>
|
||||||
<td><a href="https://downloads.apache.org/commons/csv/binaries/commons-csv-1.11.0-bin.tar.gz.sha512">sha512</a></td>
|
<td><a href="https://downloads.apache.org/commons/csv/binaries/commons-csv-1.12.0-bin.tar.gz.sha512">sha512</a></td>
|
||||||
<td><a href="https://downloads.apache.org/commons/csv/binaries/commons-csv-1.11.0-bin.tar.gz.asc">pgp</a></td>
|
<td><a href="https://downloads.apache.org/commons/csv/binaries/commons-csv-1.12.0-bin.tar.gz.asc">pgp</a></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><a href="[preferred]/commons/csv/binaries/commons-csv-1.11.0-bin.zip">commons-csv-1.11.0-bin.zip</a></td>
|
<td><a href="[preferred]/commons/csv/binaries/commons-csv-1.12.0-bin.zip">commons-csv-1.12.0-bin.zip</a></td>
|
||||||
<td><a href="https://downloads.apache.org/commons/csv/binaries/commons-csv-1.11.0-bin.zip.sha512">sha512</a></td>
|
<td><a href="https://downloads.apache.org/commons/csv/binaries/commons-csv-1.12.0-bin.zip.sha512">sha512</a></td>
|
||||||
<td><a href="https://downloads.apache.org/commons/csv/binaries/commons-csv-1.11.0-bin.zip.asc">pgp</a></td>
|
<td><a href="https://downloads.apache.org/commons/csv/binaries/commons-csv-1.12.0-bin.zip.asc">pgp</a></td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
</subsection>
|
</subsection>
|
||||||
<subsection name="Source">
|
<subsection name="Source">
|
||||||
<table>
|
<table>
|
||||||
<tr>
|
<tr>
|
||||||
<td><a href="[preferred]/commons/csv/source/commons-csv-1.11.0-src.tar.gz">commons-csv-1.11.0-src.tar.gz</a></td>
|
<td><a href="[preferred]/commons/csv/source/commons-csv-1.12.0-src.tar.gz">commons-csv-1.12.0-src.tar.gz</a></td>
|
||||||
<td><a href="https://downloads.apache.org/commons/csv/source/commons-csv-1.11.0-src.tar.gz.sha512">sha512</a></td>
|
<td><a href="https://downloads.apache.org/commons/csv/source/commons-csv-1.12.0-src.tar.gz.sha512">sha512</a></td>
|
||||||
<td><a href="https://downloads.apache.org/commons/csv/source/commons-csv-1.11.0-src.tar.gz.asc">pgp</a></td>
|
<td><a href="https://downloads.apache.org/commons/csv/source/commons-csv-1.12.0-src.tar.gz.asc">pgp</a></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><a href="[preferred]/commons/csv/source/commons-csv-1.11.0-src.zip">commons-csv-1.11.0-src.zip</a></td>
|
<td><a href="[preferred]/commons/csv/source/commons-csv-1.12.0-src.zip">commons-csv-1.12.0-src.zip</a></td>
|
||||||
<td><a href="https://downloads.apache.org/commons/csv/source/commons-csv-1.11.0-src.zip.sha512">sha512</a></td>
|
<td><a href="https://downloads.apache.org/commons/csv/source/commons-csv-1.12.0-src.zip.sha512">sha512</a></td>
|
||||||
<td><a href="https://downloads.apache.org/commons/csv/source/commons-csv-1.11.0-src.zip.asc">pgp</a></td>
|
<td><a href="https://downloads.apache.org/commons/csv/source/commons-csv-1.12.0-src.zip.asc">pgp</a></td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
</subsection>
|
</subsection>
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue