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-exec.git
commit 16a7dc8d44f7c2e1d528d2333a767c40782f72b0
Author: Gary D. Gregory <garydgreg...@gmail.com>
AuthorDate: Fri May 16 14:13:40 2025 +0000
Prepare for the next release candidate
---
CONTRIBUTING.md | 17 +++++++------
README.md | 12 ++++++----
RELEASE-NOTES.txt | 52 ++++++++++++++++++++++++++++++++++++++++
src/changes/changes.xml | 2 +-
src/site/xdoc/download_exec.xml | 34 +++++++++++++-------------
src/site/xdoc/issue-tracking.xml | 12 ++++++----
src/site/xdoc/mail-lists.xml | 12 ++++++----
7 files changed, 102 insertions(+), 39 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5636d4ac..e1199f33 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -41,9 +41,8 @@
Contributing to Apache Commons Exec
======================
-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, `EXEC-123-InputStream`.
+ * A good topic branch name can be the JIRA bug ID plus a keyword, e.g.
`EXEC-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, `[EXEC-123] Close input stream earlier`
+ * For example, `[EXEC-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 a90eb4a5..7d76db01 100644
--- a/README.md
+++ b/README.md
@@ -45,7 +45,7 @@ Apache Commons Exec
[](https://github.com/apache/commons-exec/actions/workflows/maven.yml)
[](https://search.maven.org/artifact/org.apache.commons/commons-exec)
-[](https://javadoc.io/doc/org.apache.commons/commons-exec/1.4.0)
+[](https://javadoc.io/doc/org.apache.commons/commons-exec/1.5.0)
[](https://github.com/apache/commons-exec/actions/workflows/codeql-analysis.yml)
[](https://api.securityscorecards.dev/projects/github.com/apache/commons-exec)
@@ -62,20 +62,20 @@ Getting the latest release
--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-exec/download_exec.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-exec</artifactId>
- <version>1.4.0</version>
+ <version>1.5.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 -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 40aa1d7e..34a78df8 100644
--- a/RELEASE-NOTES.txt
+++ b/RELEASE-NOTES.txt
@@ -14,6 +14,58 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied.
See the License for the specific language governing permissions and
limitations under the License.
+Apache Commons Exec 1.5.0 Release Notes
+---------------------------------------
+
+The Apache Commons Exec team is pleased to announce the release of Apache
Commons Exec 1.5.0.
+
+Apache Commons Exec is a library to reliably execute external processes from
within the JVM.
+
+Maintenance and feature Release (Java 8 or above)
+
+Changes in this version include:
+
+New features:
+o Add Maven property project.build.outputTimestamp for build
reproducibility. Thanks to Gary Gregory.
+o Add CommandLine.CommandLine(Path). Thanks to Gary Gregory.
+o Add Executor.getWorkingDirectoryPath(). Thanks to Gary Gregory.
+o Add DefaultExecutor.Builder.setWorkingDirectory(Path). Thanks to
Gary Gregory.
+o Add CommandLauncher.exec(CommandLine, Map<String, String>, Path).
Thanks to Gary Gregory.
+
+Fixed Bugs:
+o EXEC-122: Document PumpStreamHandler stream thread-safety requirements.
Thanks to Marcono1234.
+o Fix CI only running on Ubuntu and improve OS-specific tests #143.
Thanks to Marcono1234.
+o Fix PMD UnnecessaryFullyQualifiedName in DefaultExecutor. Thanks
to Gary Gregory.
+o Fix PMD EmptyCatchBlock by allowing commented blocks. Thanks to
Gary Gregory.
+o Fix PMD EmptyControlStatement by allowing commented blocks.
Thanks to Gary Gregory.
+o Replace OS.OS_* use of Locale.ENGLISH with Locale.ROOT. Thanks to
Gary Gregory.
+o Deprecate DebugUtils.DebugUtils(). Thanks to Gary Gregory.
+o Deprecate MapUtils.MapUtils(). Thanks to Gary Gregory.
+o Deprecate StringUtils.StringUtils(). Thanks to Gary Gregory.
+o Fix Javadoc warnings. Thanks to Gary Gregory.
+o Fix SpotBugs AT_STALE_THREAD_WRITE_OF_PRIMITIVE: Shared primitive
variable "shouldDestroy" in one thread may not yield the value of the most
recent write from another thread
[org.apache.commons.exec.ShutdownHookProcessDestroyer$ProcessDestroyerThread].
Thanks to Gary Gregory, SpotBugs.
+o Fix SpotBugs AT_STALE_THREAD_WRITE_OF_PRIMITIVE: Shared primitive
variable "added" in one thread may not yield the value of the most recent write
from another thread [org.apache.commons.exec.ShutdownHookProcessDestroyer].
Thanks to Gary Gregory, SpotBugs.
+
+Changes:
+o Bump org.apache.commons:commons-parent from 65 to 83 #174, #204,
#212, #214, #219, #223, #226, #233, #253. Thanks to Dependabot, Gary Gregory.
+
+Removed:
+o Remove obsolete and unmaintained Ant build file. Thanks to Gary
Gregory.
+
+Historical list of changes:
https://commons.apache.org/proper/commons-exec//changes.html
+
+For complete information on Apache Commons Exec, including instructions on how
to submit bug reports,
+patches, or suggestions for improvement, see the Apache Commons Exec website:
+
+https://commons.apache.org/proper/commons-exec/
+
+Download page:
https://commons.apache.org/proper/commons-exec//download_exec.cgi
+
+Have fun!
+-Apache Commons Team
+
+=============================================================================
+
Apache Commons Exec
Version 1.4.0
Release Notes
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 93bbea30..a5be36fc 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -24,7 +24,7 @@
<title>Apache Commons Exec Release Notes</title>
</properties>
<body>
- <release version="1.5.0" date="YYYY-MM-DD" description="Maintenance
and feature Release (Java 8 or above)">
+ <release version="1.5.0" date="2025-05-16" description="Maintenance
and feature Release (Java 8 or above)">
<!-- ADD -->
<action type="add" dev="ggregory" due-to="Gary Gregory">Add Maven
property project.build.outputTimestamp for build reproducibility.</action>
<action type="add" dev="ggregory" due-to="Gary Gregory">Add
CommandLine.CommandLine(Path).</action>
diff --git a/src/site/xdoc/download_exec.xml b/src/site/xdoc/download_exec.xml
index e4830cda..1efc80e2 100644
--- a/src/site/xdoc/download_exec.xml
+++ b/src/site/xdoc/download_exec.xml
@@ -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 Exec</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 Exec">
@@ -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 Exec 1.4.0 ">
+ <section name="Apache Commons Exec 1.5.0 ">
<subsection name="Binaries">
<table>
<tr>
- <td><a
href="[preferred]/commons/exec/binaries/commons-exec-1.4.0-bin.tar.gz">commons-exec-1.4.0-bin.tar.gz</a></td>
- <td><a
href="https://downloads.apache.org/commons/exec/binaries/commons-exec-1.4.0-bin.tar.gz.sha512";>sha512</a></td>
- <td><a
href="https://downloads.apache.org/commons/exec/binaries/commons-exec-1.4.0-bin.tar.gz.asc";>pgp</a></td>
+ <td><a
href="[preferred]/commons/exec/binaries/commons-exec-1.5.0-bin.tar.gz">commons-exec-1.5.0-bin.tar.gz</a></td>
+ <td><a
href="https://downloads.apache.org/commons/exec/binaries/commons-exec-1.5.0-bin.tar.gz.sha512";>sha512</a></td>
+ <td><a
href="https://downloads.apache.org/commons/exec/binaries/commons-exec-1.5.0-bin.tar.gz.asc";>pgp</a></td>
</tr>
<tr>
- <td><a
href="[preferred]/commons/exec/binaries/commons-exec-1.4.0-bin.zip">commons-exec-1.4.0-bin.zip</a></td>
- <td><a
href="https://downloads.apache.org/commons/exec/binaries/commons-exec-1.4.0-bin.zip.sha512";>sha512</a></td>
- <td><a
href="https://downloads.apache.org/commons/exec/binaries/commons-exec-1.4.0-bin.zip.asc";>pgp</a></td>
+ <td><a
href="[preferred]/commons/exec/binaries/commons-exec-1.5.0-bin.zip">commons-exec-1.5.0-bin.zip</a></td>
+ <td><a
href="https://downloads.apache.org/commons/exec/binaries/commons-exec-1.5.0-bin.zip.sha512";>sha512</a></td>
+ <td><a
href="https://downloads.apache.org/commons/exec/binaries/commons-exec-1.5.0-bin.zip.asc";>pgp</a></td>
</tr>
</table>
</subsection>
<subsection name="Source">
<table>
<tr>
- <td><a
href="[preferred]/commons/exec/source/commons-exec-1.4.0-src.tar.gz">commons-exec-1.4.0-src.tar.gz</a></td>
- <td><a
href="https://downloads.apache.org/commons/exec/source/commons-exec-1.4.0-src.tar.gz.sha512";>sha512</a></td>
- <td><a
href="https://downloads.apache.org/commons/exec/source/commons-exec-1.4.0-src.tar.gz.asc";>pgp</a></td>
+ <td><a
href="[preferred]/commons/exec/source/commons-exec-1.5.0-src.tar.gz">commons-exec-1.5.0-src.tar.gz</a></td>
+ <td><a
href="https://downloads.apache.org/commons/exec/source/commons-exec-1.5.0-src.tar.gz.sha512";>sha512</a></td>
+ <td><a
href="https://downloads.apache.org/commons/exec/source/commons-exec-1.5.0-src.tar.gz.asc";>pgp</a></td>
</tr>
<tr>
- <td><a
href="[preferred]/commons/exec/source/commons-exec-1.4.0-src.zip">commons-exec-1.4.0-src.zip</a></td>
- <td><a
href="https://downloads.apache.org/commons/exec/source/commons-exec-1.4.0-src.zip.sha512";>sha512</a></td>
- <td><a
href="https://downloads.apache.org/commons/exec/source/commons-exec-1.4.0-src.zip.asc";>pgp</a></td>
+ <td><a
href="[preferred]/commons/exec/source/commons-exec-1.5.0-src.zip">commons-exec-1.5.0-src.zip</a></td>
+ <td><a
href="https://downloads.apache.org/commons/exec/source/commons-exec-1.5.0-src.zip.sha512";>sha512</a></td>
+ <td><a
href="https://downloads.apache.org/commons/exec/source/commons-exec-1.5.0-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 fa319034..f175f3d9 100644
--- a/src/site/xdoc/issue-tracking.xml
+++ b/src/site/xdoc/issue-tracking.xml
@@ -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 Exec 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 Exec please do the following:
+ </p>
<ol>
<li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310814&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=12310814&issuetype=1&priority=4&assignee=-1";>bug
report</a>
or <a
href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310814&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 Exec 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=12310814&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>All
Open Apache Commons Exec bugs</a></li>
<li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310814&sorter/field=issuekey&sorter/order=DESC&status=5&status=6";>All
Resolved Apache Commons Exec bugs</a></li>
<li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310814&sorter/field=issuekey&sorter/order=DESC";>All
Apache Commons Exec 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 a56afe12..595a9403 100644
--- a/src/site/xdoc/mail-lists.xml
+++ b/src/site/xdoc/mail-lists.xml
@@ -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 Exec 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>[exec] Problem with the ...</li>
- </ul>
</p>
+ <ul>
+ <li>[exec] Problem with the ...</li>
+ </ul>
<p>
Questions related to the usage of Apache Commons Exec should be posted
to the
<a
href="https://lists.apache.org/list.html?u...@commons.apache.org";>User List</a>.
