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-build-plugin.git
The following commit(s) were added to refs/heads/master by this push: new d5f1721 Prepare for the next release candidate. d5f1721 is described below commit d5f172188bdd90ffe861c40a6b5e7510a2e5bccd Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Sat Sep 24 10:43:48 2022 -0400 Prepare for the next release candidate. --- .../commons-xdoc-templates/readme-md-template.md | 213 +++++++++++---------- 1 file changed, 107 insertions(+), 106 deletions(-) diff --git a/src/main/resources/commons-xdoc-templates/readme-md-template.md b/src/main/resources/commons-xdoc-templates/readme-md-template.md index b152009..509ed23 100644 --- a/src/main/resources/commons-xdoc-templates/readme-md-template.md +++ b/src/main/resources/commons-xdoc-templates/readme-md-template.md @@ -1,106 +1,107 @@ -<!--- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - 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 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - 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. ---> -<!--- - +======================================================================+ - |**** ****| - |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****| - |**** DO NOT EDIT DIRECTLY ****| - |**** ****| - +======================================================================+ - | TEMPLATE FILE: readme-md-template.md | - | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates | - +======================================================================+ - | | - | 1) Re-generate using: mvn commons-build:readme-md | - | | - | 2) Set the following properties in the component's pom: | - | - commons.componentid (required, alphabetic, lower case) | - | - commons.release.version (required) | - | | - | 3) Example Properties | - | | - | <properties> | - | <commons.componentid>math</commons.componentid> | - | <commons.release.version>1.2</commons.release.version> | - | </properties> | - | | - +======================================================================+ ----> -@NAME@ -=================== - -[![GitHub Actions Status](https://github.com/apache/commons-@ID@/workflows/Java%20CI/badge.svg)](https://github.com/apache/commons-@ID@/actions) -[![Coverage Status](https://codecov.io/gh/apache/commons-@ID@/branch/master/graph/badge.svg)](https://app.codecov.io/gh/apache/commons-@ID@) -[![Maven Central](https://maven-badges.herokuapp.com/maven-central/@GROUPID@/@ARTIFACTCOREID@/badge.svg?gav=true)](https://maven-badges.herokuapp.com/maven-central/@GROUPID@/@ARTIFACTCOREID@/?gav=true) -[![Javadocs](https://javadoc.io/badge/@GROUPID@/@ARTIFACTCOREID@/@VERSION@.svg)](https://javadoc.io/doc/@GROUPID@/@ARTIFACTCOREID@/@VERSION@) -[![CodeQL](https://github.com/apache/commons-@ID@/workflows/CodeQL/badge.svg)](hhttps://github.com/apache/commons-@ID@/actions/workflows/codeql-analysis.yml?query=workflow%3ACodeQL) - -@DESCRIPTION@ - -Documentation -------------- - -More information can be found on the [@NAME@ homepage](https://commons.apache.org/proper/commons-@ID@). -The [Javadoc](https://commons.apache.org/proper/commons-@ID@/apidocs) can be browsed. -Questions related to the usage of @NAME@ should be posted to the [user mailing list][ml]. - -Where can I get the latest release? ------------------------------------ -You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-@ID@/download_@ID@.cgi). - -Alternatively you can pull it from the central Maven repositories: - -```xml -<dependency> - <groupId>@GROUPID@</groupId> - <artifactId>@ARTIFACTCOREID@</artifactId> - <version>@VERSION@</version> -</dependency> -``` - -Contributing ------------- - -We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors. -There are some guidelines which will make applying PRs easier for us: -+ No tabs! Please use spaces for indentation. -+ Respect the code style. -+ 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```. - -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). - -License -------- -This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0). - -See the `NOTICE.txt` file for required notices and attributions. - -Donations ---------- -You like @NAME@? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development. - -Additional Resources --------------------- - -+ [Apache Commons Homepage](https://commons.apache.org/) -+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/@JIRA_ID@) -+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) -+ `#apache-commons` IRC channel on `irc.freenode.org` - -[ml]:https://commons.apache.org/mail-lists.html +<!--- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + 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 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + 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. +--> +<!--- + +======================================================================+ + |**** ****| + |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****| + |**** DO NOT EDIT DIRECTLY ****| + |**** ****| + +======================================================================+ + | TEMPLATE FILE: readme-md-template.md | + | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates | + +======================================================================+ + | | + | 1) Re-generate using: mvn commons-build:readme-md | + | | + | 2) Set the following properties in the component's pom: | + | - commons.componentid (required, alphabetic, lower case) | + | - commons.release.version (required) | + | | + | 3) Example Properties | + | | + | <properties> | + | <commons.componentid>math</commons.componentid> | + | <commons.release.version>1.2</commons.release.version> | + | </properties> | + | | + +======================================================================+ +---> +@NAME@ +=================== + +[![GitHub Actions Status](https://github.com/apache/commons-@ID@/workflows/Java%20CI/badge.svg)](https://github.com/apache/commons-@ID@/actions) +[![Coverage Status](https://codecov.io/gh/apache/commons-@ID@/branch/master/graph/badge.svg)](https://app.codecov.io/gh/apache/commons-@ID@) +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/@GROUPID@/@ARTIFACTCOREID@/badge.svg?gav=true)](https://maven-badges.herokuapp.com/maven-central/@GROUPID@/@ARTIFACTCOREID@/?gav=true) +[![Javadocs](https://javadoc.io/badge/@GROUPID@/@ARTIFACTCOREID@/@VERSION@.svg)](https://javadoc.io/doc/@GROUPID@/@ARTIFACTCOREID@/@VERSION@) +[![CodeQL](https://github.com/apache/commons-@ID@/workflows/CodeQL/badge.svg)](hhttps://github.com/apache/commons-@ID@/actions/workflows/codeql-analysis.yml?query=workflow%3ACodeQL) +[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/apache/commons-text/badge)](https://api.securityscorecards.dev/projects/github.com/apache/commons-text) + +@DESCRIPTION@ + +Documentation +------------- + +More information can be found on the [@NAME@ homepage](https://commons.apache.org/proper/commons-@ID@). +The [Javadoc](https://commons.apache.org/proper/commons-@ID@/apidocs) can be browsed. +Questions related to the usage of @NAME@ should be posted to the [user mailing list][ml]. + +Where can I get the latest release? +----------------------------------- +You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-@ID@/download_@ID@.cgi). + +Alternatively you can pull it from the central Maven repositories: + +```xml +<dependency> + <groupId>@GROUPID@</groupId> + <artifactId>@ARTIFACTCOREID@</artifactId> + <version>@VERSION@</version> +</dependency> +``` + +Contributing +------------ + +We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors. +There are some guidelines which will make applying PRs easier for us: ++ No tabs! Please use spaces for indentation. ++ Respect the code style. ++ 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```. + +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). + +License +------- +This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0). + +See the `NOTICE.txt` file for required notices and attributions. + +Donations +--------- +You like @NAME@? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development. + +Additional Resources +-------------------- + ++ [Apache Commons Homepage](https://commons.apache.org/) ++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/@JIRA_ID@) ++ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) ++ `#apache-commons` IRC channel on `irc.freenode.org` + +[ml]:https://commons.apache.org/mail-lists.html