This is an automated email from the ASF dual-hosted git repository. markt pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-daemon.git
commit 9285800434aa150e6099fd99643f5603a7d66fe7 Author: Mark Thomas <[email protected]> AuthorDate: Wed Nov 19 15:25:42 2025 +0000 Update generated files. --- CONTRIBUTING.md | 17 ++++++++++------- README.md | 15 ++++++++------- src/site/xdoc/download_daemon.xml | 34 ++++++++++++++++++---------------- src/site/xdoc/issue-tracking.xml | 12 +++++++----- src/site/xdoc/mail-lists.xml | 12 +++++++----- 5 files changed, 50 insertions(+), 40 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6284f10..26f0c39 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,9 +41,8 @@ Contributing to Apache Commons Daemon ====================== -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, `DAEMON-123-InputStream`. + * A good topic branch name can be the JIRA bug ID plus a keyword, e.g. `DAEMON-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, `[DAEMON-123] Close input stream earlier` + * For example, `[DAEMON-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 4e10d6d..cd755de 100644 --- a/README.md +++ b/README.md @@ -44,9 +44,8 @@ Apache Commons Daemon =================== [](https://github.com/apache/commons-daemon/actions/workflows/maven.yml) -[](https://app.codecov.io/gh/apache/commons-daemon) -[](https://maven-badges.herokuapp.com/maven-central/commons-daemon/commons-daemon/?gav=true) -[](https://javadoc.io/doc/commons-daemon/commons-daemon/1.4.1) +[](https://search.maven.org/artifact/commons-daemon/commons-daemon) +[](https://javadoc.io/doc/commons-daemon/commons-daemon/1.5.0) [](https://github.com/apache/commons-daemon/actions/workflows/codeql-analysis.yml) [](https://api.securityscorecards.dev/projects/github.com/apache/commons-daemon) @@ -66,20 +65,20 @@ Getting the latest release -------------------------- You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-daemon/download_daemon.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-daemon</groupId> <artifactId>commons-daemon</artifactId> - <version>1.4.1</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. @@ -92,7 +91,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/src/site/xdoc/download_daemon.xml b/src/site/xdoc/download_daemon.xml index 74fb270..29cdc15 100644 --- a/src/site/xdoc/download_daemon.xml +++ b/src/site/xdoc/download_daemon.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 Daemon</title> - <author email="[email protected]">Apache Commons Documentation Team</author> + <author email="[email protected]">Apache Commons Team</author> </properties> <body> <section name="Download Apache Commons Daemon"> @@ -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 Daemon 1.4.1 "> + <section name="Apache Commons Daemon 1.5.0 "> <subsection name="Binaries"> <table> <tr> - <td><a href="[preferred]/commons/daemon/binaries/commons-daemon-1.4.1-bin.tar.gz">commons-daemon-1.4.1-bin.tar.gz</a></td> - <td><a href="https://downloads.apache.org/commons/daemon/binaries/commons-daemon-1.4.1-bin.tar.gz.sha512";>sha512</a></td> - <td><a href="https://downloads.apache.org/commons/daemon/binaries/commons-daemon-1.4.1-bin.tar.gz.asc";>pgp</a></td> + <td><a href="[preferred]/commons/daemon/binaries/commons-daemon-1.5.0-bin.tar.gz">commons-daemon-1.5.0-bin.tar.gz</a></td> + <td><a href="https://downloads.apache.org/commons/daemon/binaries/commons-daemon-1.5.0-bin.tar.gz.sha512";>sha512</a></td> + <td><a href="https://downloads.apache.org/commons/daemon/binaries/commons-daemon-1.5.0-bin.tar.gz.asc";>pgp</a></td> </tr> <tr> - <td><a href="[preferred]/commons/daemon/binaries/commons-daemon-1.4.1-bin.zip">commons-daemon-1.4.1-bin.zip</a></td> - <td><a href="https://downloads.apache.org/commons/daemon/binaries/commons-daemon-1.4.1-bin.zip.sha512";>sha512</a></td> - <td><a href="https://downloads.apache.org/commons/daemon/binaries/commons-daemon-1.4.1-bin.zip.asc";>pgp</a></td> + <td><a href="[preferred]/commons/daemon/binaries/commons-daemon-1.5.0-bin.zip">commons-daemon-1.5.0-bin.zip</a></td> + <td><a href="https://downloads.apache.org/commons/daemon/binaries/commons-daemon-1.5.0-bin.zip.sha512";>sha512</a></td> + <td><a href="https://downloads.apache.org/commons/daemon/binaries/commons-daemon-1.5.0-bin.zip.asc";>pgp</a></td> </tr> </table> </subsection> <subsection name="Source"> <table> <tr> - <td><a href="[preferred]/commons/daemon/source/commons-daemon-1.4.1-src.tar.gz">commons-daemon-1.4.1-src.tar.gz</a></td> - <td><a href="https://downloads.apache.org/commons/daemon/source/commons-daemon-1.4.1-src.tar.gz.sha512";>sha512</a></td> - <td><a href="https://downloads.apache.org/commons/daemon/source/commons-daemon-1.4.1-src.tar.gz.asc";>pgp</a></td> + <td><a href="[preferred]/commons/daemon/source/commons-daemon-1.5.0-src.tar.gz">commons-daemon-1.5.0-src.tar.gz</a></td> + <td><a href="https://downloads.apache.org/commons/daemon/source/commons-daemon-1.5.0-src.tar.gz.sha512";>sha512</a></td> + <td><a href="https://downloads.apache.org/commons/daemon/source/commons-daemon-1.5.0-src.tar.gz.asc";>pgp</a></td> </tr> <tr> - <td><a href="[preferred]/commons/daemon/source/commons-daemon-1.4.1-src.zip">commons-daemon-1.4.1-src.zip</a></td> - <td><a href="https://downloads.apache.org/commons/daemon/source/commons-daemon-1.4.1-src.zip.sha512";>sha512</a></td> - <td><a href="https://downloads.apache.org/commons/daemon/source/commons-daemon-1.4.1-src.zip.asc";>pgp</a></td> + <td><a href="[preferred]/commons/daemon/source/commons-daemon-1.5.0-src.zip">commons-daemon-1.5.0-src.zip</a></td> + <td><a href="https://downloads.apache.org/commons/daemon/source/commons-daemon-1.5.0-src.zip.sha512";>sha512</a></td> + <td><a href="https://downloads.apache.org/commons/daemon/source/commons-daemon-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 2e95ae4..6221911 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 Daemon Issue tracking</title> - <author email="[email protected]">Apache Commons Documentation Team</author> + <author email="[email protected]">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 Daemon please do the following: + </p> <ol> <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310468&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=12310468&issuetype=1&priority=4&assignee=-1";>bug report</a> or <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310468&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 Daemon 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=12310468&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>All Open Apache Commons Daemon bugs</a></li> <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310468&sorter/field=issuekey&sorter/order=DESC&status=5&status=6";>All Resolved Apache Commons Daemon bugs</a></li> <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310468&sorter/field=issuekey&sorter/order=DESC";>All Apache Commons Daemon 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 dd51ac4..b8cd30b 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 Daemon Mailing Lists</title> - <author email="[email protected]">Apache Commons Documentation Team</author> + <author email="[email protected]">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>[daemon] Problem with the ...</li> - </ul> </p> + <ul> + <li>[daemon] Problem with the ...</li> + </ul> <p> Questions related to the usage of Apache Commons Daemon should be posted to the <a href="https://lists.apache.org/[email protected]";>User List</a>.
