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-imaging.git
commit 53a7d0533338176171566363ecef089c8a659e81
Author: Gary D. Gregory <garydgreg...@gmail.com>
AuthorDate: Sun Apr 27 15:12:44 2025 +0000
Prepare for the next release candidate
---
CONTRIBUTING.md | 19 +++++++-----
README.md | 14 +++++----
RELEASE-NOTES.txt | 63 ++++++++++++++++++++++++++++++++++++++
src/changes/changes.xml | 2 +-
src/site/xdoc/download_imaging.xml | 36 ++++++++++++----------
src/site/xdoc/issue-tracking.xml | 14 +++++----
src/site/xdoc/mail-lists.xml | 14 +++++----
7 files changed, 118 insertions(+), 44 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 72fc9bd2..fb7ee3f6 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -6,7 +6,7 @@
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
+ https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
@@ -41,9 +41,8 @@
Contributing to Apache Commons Imaging
======================
-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,16 +61,20 @@ Making Changes
+ Create a _topic branch_ for your isolated work.
* Usually you should base your branch from the `master` branch.
- * A good topic branch name can be the JIRA bug id plus a keyword, for
example, `IMAGING-123-InputStream`.
+ * A good topic branch name can be the JIRA bug ID plus a keyword, e.g.
`IMAGING-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.
- * For example, `[IMAGING-123] Close input stream earlier`
+ * For example, `[IMAGING-123] Close input stream sooner`
+ Respect the original code style:
+ Only use spaces for indentation; you can check for unnecessary whitespace
with `git diff` before committing.
+ 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.
-+ 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.
++ Write unit tests that match behavioral changes, where the tests fail if the
changes to the runtime are not applied. This may not always be possible but is
a best-practice.
+Unit tests are typically in the `src/test/java` directory.
++ Run a successful build using the default [Maven](https://maven.apache.org/)
goal with `mvn`; that's `mvn` on the command line by itself.
++ Write a pull request description that is detailed enough to understand what
the pull request does, how, and why.
++ Each commit in the pull request should have a meaningful subject line and
body. Note that commits might be squashed by a maintainer on merge.
+
Making Trivial Changes
----------------------
diff --git a/README.md b/README.md
index ff3d3c53..110cbe38 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
+ https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
@@ -45,7 +45,7 @@ Apache Commons Imaging
[](https://github.com/apache/commons-imaging/actions/workflows/maven.yml)
[](https://search.maven.org/artifact/org.apache.commons/commons-imaging)
-[](https://javadoc.io/doc/org.apache.commons/commons-imaging/1.0.0-alpha5)
+[](https://javadoc.io/doc/org.apache.commons/commons-imaging/1.0.0-alpha6)
[](https://github.com/apache/commons-imaging/actions/workflows/codeql-analysis.yml)
[](https://api.securityscorecards.dev/projects/github.com/apache/commons-imaging)
@@ -62,20 +62,20 @@ Getting the latest release
--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-imaging/download_imaging.cgi).
-Alternatively, you can pull it from the central Maven repositories:
+Alternatively, you can pull it from the central Maven repositories:
```xml
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-imaging</artifactId>
- <version>1.0.0-alpha5</version>
+ <version>1.0.0-alpha6</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 -Pjacoco`
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 6fce9794..34d8b126 100644
--- a/RELEASE-NOTES.txt
+++ b/RELEASE-NOTES.txt
@@ -1,3 +1,66 @@
+Apache Commons Imaging 1.0.0-alpha6 Release Notes
+------------------------------------------------_
+
+The Apache Commons Imaging team is pleased to announce the release of Apache
Commons Imaging 1.0.0-alpha6.
+
+Apache Commons Imaging (previously Sanselan) is a pure-Java image library.
+
+The 1.0.0-alpha6 release requires Java 8.
+
+
+New features
+------------
+
+* Add an Imaging-specific security page #439. Thanks to Arnout
Engelen.
+* Add Maven property commons.taglist.version for debugging.
Thanks to Gary Gregory.
+* Add support of GPSHPositioningError in GpsTagConstants #451.
Thanks to Stefal, Gary Gregory.
+* Support Extensions from PNG 1.2 Specification, Version 1.5.0
#269. Thanks to Glavo.
+* Optionally force UTF-8 encoding for IPTC records #477. Thanks
to Thomas Stieler, Gary Gregory.
+* Add Maven PMD check to the default build. Thanks to Gary
Gregory.
+
+Fixed Bugs
+----------
+
+* Replace Locale.ENGLISH with Locale.ROOT processing file names.
Thanks to Gary Gregory.
+* Fix PMD UnnecessaryFullyQualifiedName. Thanks to Gary Gregory.
+* Fix PMD TooManyStaticImports. Thanks to Gary Gregory.
+* Fix PMD UnusedFormalParameter. Thanks to Gary Gregory.
+* Fix PMD UnusedLocalVariable. Thanks to Gary Gregory.
+* Increase default block size in byte sources from 1024 to 8192
bytes. Thanks to Gary Gregory.
+* Remove double ImagingException from method signatures #462.
Thanks to Sebastian Schlatow.
+* Fix all PMD issues. Thanks to Gary Gregory.
+* Fix SpotBugs CT_CONSTRUCTOR_THROW. Thanks to Gary Gregory.
+
+Changes
+-------
+
+* Bump org.apache.commons:commons-parent from 69 to 81 #400,
#406, #428, #430, #436, #442, #445, #545. Thanks to Dependabot, Gary Gregory.
+* Bump org.apache.commons:commons-lang3 from 3.14.0 to 3.17.0
#416, #423, #431. Thanks to Dependabot.
+* Bump commons-io:commons-io from 2.16.1 to 2.19.0 #437, #464.
Thanks to Dependabot.
+* Bump org.codehaus.mojo:taglist-maven-plugin from 3.1.0 to
3.2.1 #453. Thanks to Dependabot.
+
+Removed
+-------
+
+* Remove direct dependency on org.hamcrest:hamcrest. Thanks to
Dependabot.
+* Rename methods BinaryFunctions.findNull() to indexOf0() like
String. Thanks to Dependabot.
+* Rename method BinaryFunctions.slice() to copyOfRange() like
Arrays. Thanks to Dependabot.
+* Rename method BinaryFunctions.head() to copyOfStart() like
Arrays. Thanks to Dependabot.
+* Replace BinaryFunctions.startsWith(byte[], BinaryConstant)
with BinaryConstant.isStartOf(byte[]). Thanks to Dependabot.
+
+Historical list of changes:
https://commons.apache.org/proper/commons-imaging//changes.html
+
+For complete information on Apache Commons Imaging, including instructions on
how to submit bug reports,
+patches, or suggestions for improvement, see the Apache Commons Imaging
website:
+
+https://commons.apache.org/proper/commons-imaging/
+
+Download page:
https://commons.apache.org/proper/commons-imaging//download_imaging.cgi
+
+Have fun!
+-Apache Commons Team
+
+-----------------------------------------------------------------------------
Apache Commons Imaging 1.0.0-alpha5 Release Notes
-------------------------------------------------
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 43673ead..9de269d8 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -46,7 +46,7 @@ The <action> type attribute can be add,update,fix,remove.
<title>Apache Commons Imaging Release Notes</title>
</properties>
<body>
- <release version="1.0.0-alpha6" date="YYYY-MM-DD" description="The
1.0.0-alpha6 release requires Java 8.">
+ <release version="1.0.0-alpha6" date="2025-04-27" description="The
1.0.0-alpha6 release requires Java 8.">
<!-- FIX -->
<action dev="ggregory" type="fix" due-to="Gary Gregory">Replace
Locale.ENGLISH with Locale.ROOT processing file names.</action>
<action dev="ggregory" type="fix" due-to="Gary Gregory">Fix PMD
UnnecessaryFullyQualifiedName.</action>
diff --git a/src/site/xdoc/download_imaging.xml
b/src/site/xdoc/download_imaging.xml
index a69ee710..56b62956 100644
--- a/src/site/xdoc/download_imaging.xml
+++ b/src/site/xdoc/download_imaging.xml
@@ -7,7 +7,7 @@ The ASF licenses this file to You under the Apache License,
Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
+ https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
@@ -56,10 +56,12 @@ limitations under the License.
| |
+======================================================================+
-->
-<document>
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Download Apache Commons Imaging</title>
- <author email="d...@commons.apache.org">Apache Commons Documentation
Team</author>
+ <author email="d...@commons.apache.org">Apache Commons Team</author>
</properties>
<body>
<section name="Download Apache Commons Imaging">
@@ -79,7 +81,7 @@ limitations under the License.
mirrors (at the end of the mirrors list) that should be
available.
<br></br>
- [if-any logo]<a href="[link]"><img align="right" src="[logo]"
border="0"></img></a>[end]
+ [if-any logo]<a href="[link]"><img align="right" src="[logo]"
border="0" alt="Logo"></img></a>[end]
</p>
<form action="[location]" method="get" id="SelectMirror">
@@ -113,32 +115,32 @@ limitations under the License.
</p>
</subsection>
</section>
- <section name="Apache Commons Imaging 1.0.0-alpha5 ">
+ <section name="Apache Commons Imaging 1.0.0-alpha6 ">
<subsection name="Binaries">
<table>
<tr>
- <td><a
href="[preferred]/commons/imaging/binaries/commons-imaging-1.0.0-alpha5-bin.tar.gz">commons-imaging-1.0.0-alpha5-bin.tar.gz</a></td>
- <td><a
href="https://downloads.apache.org/commons/imaging/binaries/commons-imaging-1.0.0-alpha5-bin.tar.gz.sha512";>sha512</a></td>
- <td><a
href="https://downloads.apache.org/commons/imaging/binaries/commons-imaging-1.0.0-alpha5-bin.tar.gz.asc";>pgp</a></td>
+ <td><a
href="[preferred]/commons/imaging/binaries/commons-imaging-1.0.0-alpha6-bin.tar.gz">commons-imaging-1.0.0-alpha6-bin.tar.gz</a></td>
+ <td><a
href="https://downloads.apache.org/commons/imaging/binaries/commons-imaging-1.0.0-alpha6-bin.tar.gz.sha512";>sha512</a></td>
+ <td><a
href="https://downloads.apache.org/commons/imaging/binaries/commons-imaging-1.0.0-alpha6-bin.tar.gz.asc";>pgp</a></td>
</tr>
<tr>
- <td><a
href="[preferred]/commons/imaging/binaries/commons-imaging-1.0.0-alpha5-bin.zip">commons-imaging-1.0.0-alpha5-bin.zip</a></td>
- <td><a
href="https://downloads.apache.org/commons/imaging/binaries/commons-imaging-1.0.0-alpha5-bin.zip.sha512";>sha512</a></td>
- <td><a
href="https://downloads.apache.org/commons/imaging/binaries/commons-imaging-1.0.0-alpha5-bin.zip.asc";>pgp</a></td>
+ <td><a
href="[preferred]/commons/imaging/binaries/commons-imaging-1.0.0-alpha6-bin.zip">commons-imaging-1.0.0-alpha6-bin.zip</a></td>
+ <td><a
href="https://downloads.apache.org/commons/imaging/binaries/commons-imaging-1.0.0-alpha6-bin.zip.sha512";>sha512</a></td>
+ <td><a
href="https://downloads.apache.org/commons/imaging/binaries/commons-imaging-1.0.0-alpha6-bin.zip.asc";>pgp</a></td>
</tr>
</table>
</subsection>
<subsection name="Source">
<table>
<tr>
- <td><a
href="[preferred]/commons/imaging/source/commons-imaging-1.0.0-alpha5-src.tar.gz">commons-imaging-1.0.0-alpha5-src.tar.gz</a></td>
- <td><a
href="https://downloads.apache.org/commons/imaging/source/commons-imaging-1.0.0-alpha5-src.tar.gz.sha512";>sha512</a></td>
- <td><a
href="https://downloads.apache.org/commons/imaging/source/commons-imaging-1.0.0-alpha5-src.tar.gz.asc";>pgp</a></td>
+ <td><a
href="[preferred]/commons/imaging/source/commons-imaging-1.0.0-alpha6-src.tar.gz">commons-imaging-1.0.0-alpha6-src.tar.gz</a></td>
+ <td><a
href="https://downloads.apache.org/commons/imaging/source/commons-imaging-1.0.0-alpha6-src.tar.gz.sha512";>sha512</a></td>
+ <td><a
href="https://downloads.apache.org/commons/imaging/source/commons-imaging-1.0.0-alpha6-src.tar.gz.asc";>pgp</a></td>
</tr>
<tr>
- <td><a
href="[preferred]/commons/imaging/source/commons-imaging-1.0.0-alpha5-src.zip">commons-imaging-1.0.0-alpha5-src.zip</a></td>
- <td><a
href="https://downloads.apache.org/commons/imaging/source/commons-imaging-1.0.0-alpha5-src.zip.sha512";>sha512</a></td>
- <td><a
href="https://downloads.apache.org/commons/imaging/source/commons-imaging-1.0.0-alpha5-src.zip.asc";>pgp</a></td>
+ <td><a
href="[preferred]/commons/imaging/source/commons-imaging-1.0.0-alpha6-src.zip">commons-imaging-1.0.0-alpha6-src.zip</a></td>
+ <td><a
href="https://downloads.apache.org/commons/imaging/source/commons-imaging-1.0.0-alpha6-src.zip.sha512";>sha512</a></td>
+ <td><a
href="https://downloads.apache.org/commons/imaging/source/commons-imaging-1.0.0-alpha6-src.zip.asc";>pgp</a></td>
</tr>
</table>
</subsection>
diff --git a/src/site/xdoc/issue-tracking.xml b/src/site/xdoc/issue-tracking.xml
index a60b79b9..ae788ed1 100644
--- a/src/site/xdoc/issue-tracking.xml
+++ b/src/site/xdoc/issue-tracking.xml
@@ -7,7 +7,7 @@ The ASF licenses this file to You under the Apache License,
Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
+ https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
@@ -41,10 +41,12 @@ limitations under the License.
| |
+======================================================================+
-->
-<document>
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Apache Commons Imaging Issue tracking</title>
- <author email="d...@commons.apache.org">Apache Commons Documentation
Team</author>
+ <author email="d...@commons.apache.org">Apache Commons Team</author>
</properties>
<body>
@@ -64,6 +66,7 @@ limitations under the License.
<p>
If you would like to report a bug, or raise an enhancement request with
Apache Commons Imaging please do the following:
+ </p>
<ol>
<li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12313421&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>Search
existing open bugs</a>.
If you find your issue listed then please add a comment with your
details.</li>
@@ -73,16 +76,15 @@ limitations under the License.
<li>Submit either a <a
href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12313421&issuetype=1&priority=4&assignee=-1";>bug
report</a>
or <a
href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12313421&issuetype=4&priority=4&assignee=-1";>enhancement
request</a>.</li>
</ol>
- </p>
<p>
Please also remember these points:
+ </p>
<ul>
<li>the more information you provide, the better we can help you</li>
<li>test cases are vital, particularly for any proposed
enhancements</li>
<li>the developers of Apache Commons Imaging are all unpaid
volunteers</li>
</ul>
- </p>
<p>
For more information on creating patches see the
@@ -91,12 +93,12 @@ limitations under the License.
<p>
You may also find these links useful:
+ </p>
<ul>
<li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12313421&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>All
Open Apache Commons Imaging bugs</a></li>
<li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12313421&sorter/field=issuekey&sorter/order=DESC&status=5&status=6";>All
Resolved Apache Commons Imaging bugs</a></li>
<li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12313421&sorter/field=issuekey&sorter/order=DESC";>All
Apache Commons Imaging bugs</a></li>
</ul>
- </p>
</section>
</body>
</document>
diff --git a/src/site/xdoc/mail-lists.xml b/src/site/xdoc/mail-lists.xml
index 36091980..a8655758 100644
--- a/src/site/xdoc/mail-lists.xml
+++ b/src/site/xdoc/mail-lists.xml
@@ -7,7 +7,7 @@ The ASF licenses this file to You under the Apache License,
Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
+ https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
@@ -39,10 +39,12 @@ limitations under the License.
| |
+======================================================================+
-->
-<document>
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Apache Commons Imaging Mailing Lists</title>
- <author email="d...@commons.apache.org">Apache Commons Documentation
Team</author>
+ <author email="d...@commons.apache.org">Apache Commons Team</author>
</properties>
<body>
@@ -53,10 +55,10 @@ limitations under the License.
To make it easier for people to only read messages related to
components they are interested in,
the convention in Commons is to prefix the subject line of messages
with the component's name,
for example:
- <ul>
- <li>[imaging] Problem with the ...</li>
- </ul>
</p>
+ <ul>
+ <li>[imaging] Problem with the ...</li>
+ </ul>
<p>
Questions related to the usage of Apache Commons Imaging should be
posted to the
<a
href="https://lists.apache.org/list.html?u...@commons.apache.org";>User List</a>.
