diff --git a/.asf.yaml b/.asf.yaml new file mode 100644 index 000000000..05246b916 --- /dev/null +++ b/.asf.yaml @@ -0,0 +1,29 @@ +# 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. + +github: + description: "Apache Commons Build Plugin" + homepage: https://commons.apache.org/build-plugin/ + +notifications: + commits: commits@commons.apache.org + issues: issues@commons.apache.org + pullrequests: issues@commons.apache.org + jira_options: link label + jobs: notifications@commons.apache.org + issues_bot_dependabot: notifications@commons.apache.org + pullrequests_bot_dependabot: notifications@commons.apache.org + issues_bot_codecov-commenter: notifications@commons.apache.org + pullrequests_bot_codecov-commenter: notifications@commons.apache.org diff --git a/.travis.yml b/.github/GH-ROBOTS.txt similarity index 79% rename from .travis.yml rename to .github/GH-ROBOTS.txt index 419667dff..e3329e55f 100644 --- a/.travis.yml +++ b/.github/GH-ROBOTS.txt @@ -5,7 +5,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 +# 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, @@ -13,8 +13,7 @@ # See the License for the specific language governing permissions and # limitations under the License. -language: java -sudo: false - -jdk: - - oraclejdk8 +# Keeps on creating FUD PRs in test code +# Does not follow Apache disclosure policies +User-agent: JLLeitschuh/security-research +Disallow: * diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 000000000..9ebcd0ebb --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,27 @@ +# 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. + +version: 2 +updates: + - package-ecosystem: "maven" + directory: "/" + schedule: + interval: "weekly" + day: "friday" + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" + day: "friday" diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..d126a970c --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,28 @@ + + +Thanks for your contribution to [Apache Commons](https://commons.apache.org/)! Your help is appreciated! + +Before you push a pull request, review this list: + +- [ ] Read the [contribution guidelines](CONTRIBUTING.md) for this project. +- [ ] 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 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. +- [ ] 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. diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml new file mode 100644 index 000000000..50020ebf2 --- /dev/null +++ b/.github/workflows/codeql-analysis.yml @@ -0,0 +1,34 @@ +# 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. + +# Dummy job for now because there is no code to analyse + +name: CodeQL + +on: workflow_dispatch + # [push, pull_request] + +permissions: + contents: read + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + + - name: dummy analysis job + run: echo All is OK diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml new file mode 100644 index 000000000..9d226a458 --- /dev/null +++ b/.github/workflows/dependency-review.yml @@ -0,0 +1,31 @@ +# 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. + +name: 'Dependency Review' +on: [pull_request] + +permissions: + contents: read + +jobs: + dependency-review: + runs-on: ubuntu-latest + steps: + - name: 'Checkout Repository' + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + - name: 'Dependency Review PR' + uses: actions/dependency-review-action@da24556b548a50705dd671f47852072ea4c105d9 # v4.7.1 diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml new file mode 100644 index 000000000..a30362b00 --- /dev/null +++ b/.github/workflows/maven.yml @@ -0,0 +1,52 @@ +# 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. + +name: Java CI + +on: [push, pull_request] + +permissions: + contents: read + +jobs: + build: + + runs-on: ubuntu-22.04 # 22.04 contains svn, 24.04 doesn't + continue-on-error: ${{ matrix.experimental }} + strategy: + matrix: + java: [ 8, 11, 17, 21, 24 ] + experimental: [false] + include: + - java: 25-ea + experimental: true + + steps: + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false + - uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3 + with: + path: ~/.m2/repository + key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} + restore-keys: | + ${{ runner.os }}-maven- + - name: Set up JDK ${{ matrix.java }} + uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 # v4.7.1 + with: + distribution: 'temurin' + java-version: ${{ matrix.java }} + - name: Build with Maven + run: mvn --errors --show-version --batch-mode --no-transfer-progress -Ddoclint=all diff --git a/.github/workflows/scorecards-analysis.yml b/.github/workflows/scorecards-analysis.yml new file mode 100644 index 000000000..4162c104a --- /dev/null +++ b/.github/workflows/scorecards-analysis.yml @@ -0,0 +1,69 @@ +# 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. + +name: "Scorecards supply-chain security" + +on: + branch_protection_rule: + schedule: + - cron: "30 1 * * 6" # Weekly on Saturdays + push: + branches: [ "master" ] + +permissions: read-all + +jobs: + + analysis: + + name: "Scorecards analysis" + runs-on: ubuntu-latest + permissions: + # Needed to upload the results to the code-scanning dashboard. + security-events: write + actions: read + id-token: write # This is required for requesting the JWT + contents: read # This is required for actions/checkout + + steps: + + - name: "Checkout code" + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2 + with: + persist-credentials: false + + - name: "Run analysis" + uses: ossf/scorecard-action@f49aabe0b5af0936a0987cfb85d86b75731b0186 # 2.4.1 + with: + results_file: results.sarif + results_format: sarif + # A read-only PAT token, which is sufficient for the action to function. + # The relevant discussion: https://github.com/ossf/scorecard-action/issues/188 + repo_token: ${{ secrets.GITHUB_TOKEN }} + # Publish the results for public repositories to enable scorecard badges. + # For more details: https://github.com/ossf/scorecard-action#publishing-results + publish_results: true + + - name: "Upload artifact" + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 + with: + name: SARIF file + path: results.sarif + retention-days: 5 + + - name: "Upload to code-scanning" + uses: github/codeql-action/upload-sarif@60168efe1c415ce0f5521ea06d5c2062adbeed1b # 3.28.17 + with: + sarif_file: results.sarif diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..3ed501501 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,17 @@ + +The Apache code of conduct page is [https://www.apache.org/foundation/policies/conduct.html](https://www.apache.org/foundation/policies/conduct.html). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d02572b6a..56d08fc3f 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,38 +41,40 @@ Contributing to Apache Commons Build Plugin Maven Mojo ====================== -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 --------------- + Make sure you have a [JIRA account](https://issues.apache.org/jira/). -+ Make sure you have a [GitHub account](https://github.com/signup/free). ++ Make sure you have a [GitHub account](https://github.com/signup/free). This is not essential, but makes providing patches much easier. + If you're planning to implement a new feature it makes sense to discuss your changes on the [dev list](https://commons.apache.org/mail-lists.html) first. This way you can make sure you're not wasting your time on something that isn't considered to be in Apache Commons Build Plugin Maven Mojo's scope. + Submit a [Jira Ticket][jira] for your issue, assuming one does not already exist. + Clearly describe the issue including steps to reproduce when it is a bug. + Make sure you fill in the earliest version that you know has the issue. + Find the corresponding [repository on GitHub](https://github.com/apache/?query=commons-), -[fork](https://help.github.com/articles/fork-a-repo/) and check out your forked repository. +[fork](https://help.github.com/articles/fork-a-repo/) and check out your forked repository. If you don't have a GitHub account, you can still clone the Commons repository. Making Changes -------------- + Create a _topic branch_ for your isolated work. - * Usually you should base your branch on the `master` or `trunk` branch. - * A good topic branch name can be the JIRA bug id plus a keyword, e.g. `COMMONSSITE-123-InputStream`. + * 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, `COMMONSSITE-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. - * e.g. `COMMONSSITE-123: Close input stream earlier` + * For example, `[COMMONSSITE-123] Close input stream earlier` + Respect the original code style: - + Only use spaces for indentation. + + 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. - + 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`. -+ 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 ---------------------- @@ -80,7 +82,7 @@ Making Trivial Changes The JIRA tickets are used to generate the changelog for the next release. For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA. -In this case, it is appropriate to start the first line of a commit with '(doc)' instead of a ticket number. +In this case, it is appropriate to start the first line of a commit with '[doc]' or '[javadoc]' instead of a ticket number. Submitting Changes @@ -109,7 +111,6 @@ Additional Resources + [General GitHub documentation](https://help.github.com/) + [GitHub pull request documentation](https://help.github.com/articles/creating-a-pull-request/) + [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) -+ `#apache-commons` IRC channel on `irc.freenode.net` [cla]:https://www.apache.org/licenses/#clas [jira]:https://issues.apache.org/jira/browse/COMMONSSITE diff --git a/NOTICE.txt b/NOTICE.txt index 5381e0e99..ac0070b0e 100644 --- a/NOTICE.txt +++ b/NOTICE.txt @@ -1,5 +1,5 @@ Apache Commons Build Plugin Maven Mojo -Copyright 2008-2018 The Apache Software Foundation +Copyright 2008-2025 The Apache Software Foundation This product includes software developed at -The Apache Software Foundation (http://www.apache.org/). +The Apache Software Foundation (https://www.apache.org/). diff --git a/README.md b/README.md index fc7f2115a..439bee9a5 100644 --- a/README.md +++ b/README.md @@ -43,63 +43,83 @@ Apache Commons Build Plugin Maven Mojo =================== -[![Build Status](https://travis-ci.org/apache/commons-commons-build-plugin.svg)](https://travis-ci.org/apache/commons-commons-build-plugin) -[![Coverage Status](https://coveralls.io/repos/apache/commons-commons-build-plugin/badge.svg)](https://coveralls.io/r/apache/commons-commons-build-plugin) -[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-build-plugin/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-build-plugin/) -[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-build-plugin/1.9-SNAPSHOT.svg)](https://javadoc.io/doc/org.apache.commons/commons-build-plugin/1.9-SNAPSHOT) +[![Java CI](https://github.com/apache/commons-build-plugin/actions/workflows/maven.yml/badge.svg)](https://github.com/apache/commons-build-plugin/actions/workflows/maven.yml) +[![Maven Central](https://img.shields.io/maven-central/v/org.apache.commons/commons-build-plugin?label=Maven%20Central)](https://search.maven.org/artifact/org.apache.commons/commons-build-plugin) +[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-build-plugin/1.15.0.svg)](https://javadoc.io/doc/org.apache.commons/commons-build-plugin/1.15.0) +[![CodeQL](https://github.com/apache/commons-build-plugin/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/apache/commons-build-plugin/actions/workflows/codeql-analysis.yml) +[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/apache/commons-build-plugin/badge)](https://api.securityscorecards.dev/projects/github.com/apache/commons-build-plugin) -${project.description} +Apache Maven Mojo for Apache Commons Build tasks. + + For example: + mvn commons-build:download-page [-Dcommons.release.version=1.2.3] + + To use a SNAPSHOT version (for testing etc) + mvn org.apache.commons:commons-build-plugin:1.14.0-SNAPSHOT:download-page [-Dcommons.release.version=1.2.3] Documentation ------------- -More information can be found on the [Apache Commons Build Plugin Maven Mojo homepage](https://commons.apache.org/proper/commons-commons-build-plugin). -The [Javadoc](https://commons.apache.org/proper/commons-commons-build-plugin/javadocs/api-release) can be browsed. -Questions related to the usage of Apache Commons Build Plugin Maven Mojo should be posted to the [user mailing list][ml]. +More information can be found on the [Apache Commons Build Plugin Maven Mojo homepage](https://commons.apache.org/proper/commons-build-plugin). +The [Javadoc](https://commons.apache.org/proper/commons-build-plugin/apidocs) can be browsed. +Questions related to the usage of Apache Commons Build Plugin Maven Mojo should be posted to the [user mailing list](https://commons.apache.org/mail-lists.html). -Where can I get the latest release? ------------------------------------ -You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-commons-build-plugin/download_commons-build-plugin.cgi). +Getting the latest release +-------------------------- +You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-build-plugin/download_build-plugin.cgi). -Alternatively you can pull it from the central Maven repositories: +Alternatively, you can pull it from the central Maven repositories: ```xml org.apache.commons commons-build-plugin - 1.9-SNAPSHOT + 1.15.0 ``` +Building +-------- + +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. + Contributing ------------ -We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors. +We accept Pull Requests via GitHub. The [developer mailing list](https://commons.apache.org/mail-lists.html) 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. ++ 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 clean test```. ++ 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). 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). +This code is licensed under the [Apache License v2](https://www.apache.org/licenses/LICENSE-2.0). See the `NOTICE.txt` file for required notices and attributions. -Donations ---------- -You like Apache Commons Build Plugin Maven Mojo? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development. +Donating +-------- +You like Apache Commons Build Plugin Maven Mojo? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support development. Additional Resources -------------------- + [Apache Commons Homepage](https://commons.apache.org/) + [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/COMMONSSITE) ++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD) + [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) -+ `#apache-commons` IRC channel on `irc.freenode.org` -[ml]:https://commons.apache.org/mail-lists.html +Apache Commons Components +------------------------- + +Please see the [list of components](https://commons.apache.org/components.html) diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt index c52706d69..23e2ca4df 100644 --- a/RELEASE-NOTES.txt +++ b/RELEASE-NOTES.txt @@ -1,90 +1,264 @@ - Apache Commons Build Plugin - Release Notes +Apache Commons Build Plugin Maven Mojo 1.15.0 RELEASE NOTES +----------------------------------------------------------- +The Apache Commons team is pleased to announce Apache Commons Build Plugin Maven Mojo 1.15.0. -INTRODUCTION: +Apache Maven Mojo for Apache Commons Build tasks. -The Apache Commons Build Plugin is a Maven Plugin which can be used by Apache Commons components. +For example: +mvn commons-build:download-page [-Dcommons.release.version=1.2.3] -See: - http://commons.apache.org/commons-build-plugin/ +To use a SNAPSHOT version (for testing etc) +mvn org.apache.commons:commons-build-plugin:1.14.0-SNAPSHOT:download-page [-Dcommons.release.version=1.2.3] +This is a maintenance release. -VERSION 1.9 - 2018-06-16 ------------------------- +Changes in this version include: -Changes since the last release: -1. Fix in src/main/resources/commons-xdoc-templates/readme-md-template.md for components that have a major version number in their artifact IDs. -2. Add a goal for creating all items for pre-release. -3. Fix README.md generation typo: 'JavaDoc' -> 'Javadoc'. -4. Change the Maven goal prefix from "commons" to "commons-build". -5. Add a goal for generating the NOTICE.txt file. -6. Update platform requirement from Java 7 to Java 8. -VERSION 1.8 - 2018-04-02 ------------------------- +Fixed Bugs +---------- -Changes since the last release: -1. Fix EOL-style so generated files have correct setting -2. Change download page from MD5 to SHA1 -3. Include Javadoc badge in README.md file. +* Pick up maven-antrun-plugin version from parent POM org.apache:apache. Thanks to Gary Gregory. -VERSION 1.7 - 2016-11-18 ------------------------- +Changes +------- -Changes since the last release: -1. Include badges in the README.md file. Issue: COMMONSSITE-90. -2. Build plugin does not pass the JIRA_ID property when generating README.md. Issue: COMMONSSITE-91. +* Bump org.apache.commons:commons-parent from 78 to 79, upgrades Doxia from 1 to 2. Thanks to Gary Gregory. -VERSION 1.6 - 2016-04-24 ------------------------- -Changes since the last release -1. Added new download-page subdir property: set this (e.g. to '1.2' or 'lang-1.2' etc) to override the default of binaries/source +For complete information on Apache Commons Build Plugin Maven Mojo, including instructions on how to submit bug reports, +patches, or suggestions for improvement, see the Apache Commons Build Plugin Maven Mojo website: -VERSION 1.5 - 2015-11-28 ------------------------- +https://commons.apache.org/proper/commons-build-plugin/ -Changes since the last release: -1. Added new goals: contributing-md and readme-md - to build Markdown formatted intro files for GitHub. -2. Download Page - Better describes KEYS file (and uses https links) -3. Use Apache Commons rather than just Commons +Download page: https://commons.apache.org/proper/commons-build-plugin/download_build-plugin.cgi -VERSION 1.4 - 2012-03-06 ------------------------- +----------------------------------------------------------------------------- +Apache Commons Build Plugin Maven Mojo 1.14.1 RELEASE NOTES +----------------------------------------------------------- -Changes since the last release: -1. Fix announce mod_mbox link -2. Mailing List Page - Make it clear that you have to be subscribed to post. -3. COMMONSSITE-66 - Add support for a "commons.release.3" set of properties to offer a 3rd download option. +Apache Maven Mojo for Apache Commons Build tasks. -VERSION 1.3 - 2010-04-15 ------------------------- +For example: +mvn commons-build:download-page [-Dcommons.release.version=1.2.3] -Changes since the last release: -1. Add facility to generate custom mailing list page -2. Add new ${commons.release.name} property for the download page generation +To use a SNAPSHOT version (for testing etc) +mvn org.apache.commons:commons-build-plugin:1.14.0-SNAPSHOT:download-page [-Dcommons.release.version=1.2.3] +Maintenance release -VERSION 1.2 - 2010-02-23 ------------------------- +Changes in this version include: -Changes since the last release: -1. Improve the L&F of the download page -2. Add facility to add a second version to the download page -3. Upgrade to commons-parent version 12 -VERSION 1.1 - 2008-07-16 ------------------------- +Fixed Bugs +---------- -Changes since the last release: -1. Upgrade to commons-parent version 10 -2. Add assembly descriptors -3. Minor documentation corrections -4. COMMONSSITE-36 - plugin won't build because of missing OSGi manifest file. -5. COOMONSSITE-35 - Upgrade to Ant 1.7.1 (fixes two problems/bugs when generating - Jira/download pages). +* Fix broken URL to project location in Maven Central #320. Thanks to Capt. Cutlass. -VERSION 1.0 - 2008-02-24 ------------------------- -Initial Release +Changes +------- + +* Bump org.apache.commons:commons-parent from 69 to 78 #264, #276, #291, #301, #307, #312, #324. Thanks to Dependabot, Gary Gregory. +* Bump org.graalvm.js:js-scriptengine from 24.0.0 to 24.1.1 #248, #282, #308, #322. Thanks to Dependabot. +* Bump org.graalvm.js:js from 23.0.3 to 23.0.6 #247, #281, #321. Thanks to Dependabot. +* Bump org.apache.maven.plugin-tools:maven-plugin-tools-ant from 3.12.0 to 3.15.1 #260, #272, #292, #298. Thanks to Dependabot. +* Bump org.apache.maven.plugin-tools:maven-script-ant from 3.12.0 to 3.15.1 #259, #270, #295, #300. Thanks to Dependabot. +* Bump org.apache.maven.plugins:maven-plugin-plugin from 3.12.0 to 3.15.1 #258, #271, #299. Thanks to Dependabot. +* Bump org.apache.maven:maven-plugin-api from 3.9.6 to 3.9.9 #267, #277, #293. Thanks to Dependabot. +* Bump org.apache.maven:maven-core from 3.9.6 to 3.9.9 #268, #278, #294. Thanks to Dependabot. +* Bump org.apache.ant:ant-launcher from 1.10.14 to 1.10.15 #303. Thanks to Dependabot. +* Bump org.codehaus.mojo:jdepend-maven-plugin from 2.0 to 2.1 #311. Thanks to Dependabot. + +Removed +------- + +* Drop codecov.io badge. Thanks to Gary Gregory. + +For complete information on Apache Commons Build Plugin Maven Mojo, including instructions on how to submit bug reports, +patches, or suggestions for improvement, see the Apache Commons Build Plugin Maven Mojo website: + +https://commons.apache.org/proper/commons-build-plugin/ + +Download page: https://commons.apache.org/proper/commons-build-plugin/download_build-plugin.cgi + +----------------------------------------------------------------------------- +Apache Commons Build Plugin Maven Mojo 1.14.0 RELEASE NOTES +----------------------------------------------------------- + +Apache Maven Mojo for Apache Commons Build tasks. + +For example: +mvn commons-build:download-page [-Dcommons.release.version=1.2.3] + +To use a SNAPSHOT version (for testing etc) +mvn org.apache.commons:commons-build-plugin:1.14.0-SNAPSHOT:download-page [-Dcommons.release.version=1.2.3] + +Feature release + +Changes in this version include: + +New features +------------ + +* Add Maven property project.build.outputTimestamp for build reproducibility. Thanks to Gary Gregory. + +Fixed Bugs +---------- + +* maven-plugin-report-plugin replaces maven-plugin-plugin report goal +* Fix up errors in GHA badges for Java and CodeQL +* Only use graalvm on Java11+; update to 22.3.3 which avoids NoClassDefFoundError messages +* Replace mail-archives.apache.org with lists.apache.org +* Drop mail archives that no longer exist (markmail, gmane, old.nabble) +* Disable moditect as it fails currently + +Changes +------- + +* Bump org.apache.maven.plugins:maven-plugin-plugin from 3.10.2 to 3.11.0 Thanks to Dependabot. +* Drop IRC references Thanks to Gary Gregory. +* Bump commons-parent from 58 to 69 #240. Thanks to Gary Gregory. +* Bump org.apache.ant:ant-launcher from 1.10.12 to 1.10.14. Thanks to Dependabot, Gary Gregory. +* Disable cyclonedx - not needed +* Drop outdated, unmaintained table of components in README in favour of link to website. +* Bump org.graalvm.js:js-scriptengine from 23.1.0 to 24.0.0 #236. Thanks to Dependabot. +* Bump org.graalvm.js:js from 23.0.1 to 23.0.3. Thanks to Dependabot. +* Bump org.apache.maven:maven-core 3.9.4 to 3.9.6. Thanks to Gary Gregory. +* Bump org.apache.maven:maven-plugin-api 3.9.4 to 3.9.6. Thanks to Gary Gregory. +* Bump org.apache.maven.plugin-tools:maven-script-ant 3.9.0 to 3.12.0 #241. Thanks to Gary Gregory. +* Bump org.apache.maven.plugin-tools:maven-plugin-tools-ant from 3.9.0 to 3.12.0 #242. Thanks to Gary Gregory. +* Bump org.apache.maven.plugins:maven-artifact-plugin from 3.5.0 to 3.5.1 #393. Thanks to Dependabot, Gary Gregory. + + +For complete information on Apache Commons Build Plugin Maven Mojo, including instructions on how to submit bug reports, +patches, or suggestions for improvement, see the Apache Commons Build Plugin Maven Mojo website: + +https://commons.apache.org/proper/commons-build-plugin/ + +Download page: https://commons.apache.org/proper/commons-build-plugin/download_build-plugin.cgi + +----------------------------------------------------------------------------- +Apache Commons Build Plugin Maven Mojo 1.14.0 RELEASE NOTES +----------------------------------------------------------- + +Apache Maven Mojo for Apache Commons Build tasks. + +For example: +mvn commons-build:download-page [-Dcommons.release.version=1.2.3] + +To use a SNAPSHOT version (for testing etc) +mvn org.apache.commons:commons-build-plugin:1.14.0-SNAPSHOT:download-page [-Dcommons.release.version=1.2.3] + +Feature release + +Changes in this version include: + +New features +------------ + +* Add Maven property project.build.outputTimestamp for build reproducibility. Thanks to Gary Gregory. + +Fixed Bugs +---------- + +* maven-plugin-report-plugin replaces maven-plugin-plugin report goal +* Fix up errors in GHA badges for Java and CodeQL +* Only use graalvm on Java11+; update to 22.3.3 which avoids NoClassDefFoundError messages +* Replace mail-archives.apache.org with lists.apache.org +* Drop mail archives that no longer exist (markmail, gmane, old.nabble) +* Disable moditect as it fails currently + +Changes +------- + +* Bump org.apache.maven.plugins:maven-plugin-plugin from 3.10.2 to 3.11.0 Thanks to Dependabot. +* Drop IRC references Thanks to Gary Gregory. +* Bump commons-parent from 58 to 69 #240. Thanks to Gary Gregory. +* Bump org.apache.ant:ant-launcher from 1.10.12 to 1.10.14. Thanks to Dependabot, Gary Gregory. +* Disable cyclonedx - not needed +* Drop outdated, unmaintained table of components in README in favour of link to website. +* Bump org.graalvm.js:js-scriptengine from 23.1.0 to 24.0.0 #236. Thanks to Dependabot. +* Bump org.graalvm.js:js from 23.0.1 to 23.0.3. Thanks to Dependabot. +* Bump org.apache.maven:maven-core 3.9.4 to 3.9.6. Thanks to Gary Gregory. +* Bump org.apache.maven:maven-plugin-api 3.9.4 to 3.9.6. Thanks to Gary Gregory. +* Bump org.apache.maven.plugin-tools:maven-script-ant 3.9.0 to 3.12.0 #241. Thanks to Gary Gregory. +* Bump org.apache.maven.plugin-tools:maven-plugin-tools-ant from 3.9.0 to 3.12.0 #242. Thanks to Gary Gregory. +* Bump org.apache.maven.plugins:maven-artifact-plugin from 3.5.0 to 3.5.1 #393. Thanks to Dependabot, Gary Gregory. + + +For complete information on Apache Commons Build Plugin Maven Mojo, including instructions on how to submit bug reports, +patches, or suggestions for improvement, see the Apache Commons Build Plugin Maven Mojo website: + +https://commons.apache.org/proper/commons-build-plugin/ + +Download page: https://commons.apache.org/proper/commons-build-plugin/download_build-plugin.cgi + +----------------------------------------------------------------------------- + +Apache Commons Build Plugin Maven Mojo 1.13 RELEASE NOTES +--------------------------------------------------------- + +Apache Maven Mojo for Apache Commons Build tasks. + +For example: +mvn commons-build:download-page [-Dcommons.release.version=1.2.3] + +To use a SNAPSHOT version (for testing etc) +mvn org.apache.commons:commons-build-plugin:1.13-SNAPSHOT:download-page [-Dcommons.release.version=1.2.3] + +Feature release + +New features +------------ + +* Add property commons.dist.subdir. Thanks to Gary Gregory. +* Add github/codeql-action. Thanks to Gary Gregory. + +Fixed Bugs +---------- + +* Fix running on Java 11 and up. Use GraalVM instead of Java 8 Nashorn for JavaScript, which was deprecated in Java 11 and removed in Java 15. + Unfortunately, you will see this output on the console at the end of a successful build: + + Exception in thread "Thread-2" java.lang.NoClassDefFoundError: org/graalvm/collections/EconomicMapImpl$3 + at org.graalvm.collections.EconomicMapImpl.iterator(EconomicMapImpl.java:846) + at com.oracle.truffle.polyglot.PolyglotEngineImpl.collectAliveContexts(PolyglotEngineImpl.java:1261) + at com.oracle.truffle.polyglot.PolyglotEngineImpl.ensureClosed(PolyglotEngineImpl.java:1158) + at com.oracle.truffle.polyglot.PolyglotEngineImpl$PolyglotShutDownHook.run(PolyglotEngineImpl.java:1407) + at java.lang.Thread.run(Thread.java:750) + Caused by: java.lang.ClassNotFoundException: org.graalvm.collections.EconomicMapImpl$3 + at org.codehaus.plexus.classworlds.strategy.SelfFirstStrategy.loadClass(SelfFirstStrategy.java:50) + at org.codehaus.plexus.classworlds.realm.ClassRealm.unsynchronizedLoadClass(ClassRealm.java:271) + at org.codehaus.plexus.classworlds.realm.ClassRealm.loadClass(ClassRealm.java:247) + at org.codehaus.plexus.classworlds.realm.ClassRealm.loadClass(ClassRealm.java:239) + ... 5 more Thanks to Gary Gregory. +* Fix minor typos #79. Thanks to Marc Wrobel. +* [StepSecurity] ci: Harden GitHub Actions #162. Thanks to step-security-bot, Gary Gregory. + +Changes +------- + +* Bump Ant integration from org.apache.maven:maven-script-ant to org.apache.maven.plugin-tools:maven-script-ant 3.9.0. Thanks to Gary Gregory. +* Bump actions/cache. Thanks to Dependabot, Gary Gregory. +* Bump actions/checkout. Thanks to Dependabot, Gary Gregory. +* Bump actions/setup-java. Thanks to Gary Gregory, Dependabot. +* Bump actions/upload-artifact. Thanks to Dependabot. +* Bump github/codeql-action. Thanks to Dependabot. +* Bump maven-antrun-plugin from 1.8 to 3.1.0, #18, #71. Thanks to Dependabot. +* Bump spotbugs-maven-plugin from 4.1.3 to 4.7.3.0 #56, #58, #66, #73, #75, #77, #82, #93, #106. Thanks to Gary Gregory, Dependabot. +* Bump spotbugs from 4.1.3 to 4.7.3, #24, #26, #57, #63, #72, #80, #98. Thanks to Gary Gregory, Dependabot. +* Bump maven-plugin-plugin from 3.6.0 to 3.9.0, #33, #52, #61, #104, #127, #138, #154. Thanks to Gary Gregory. +* Bump maven-plugin-tools-ant from 3.6.0 to 3.9.0, #32, #53, #59, #126, #139, #152. Thanks to Gary Gregory. +* Bump versions-maven-plugin from 2.9.0 to 2.15.0 #64, #74, #81, #101. #115, #119. #136. Thanks to Dependabot. +* Bump commons-parent from 52 to 58 #67, #86, #110, #120, #153. Thanks to Dependabot, Gary Gregory. + + +For complete information on Apache Commons Build Plugin Maven Mojo, including instructions on how to submit bug reports, +patches, or suggestions for improvement, see the Apache Commons Build Plugin Maven Mojo website: + +https://commons.apache.org/proper/commons-build-plugin/ + +Download page: https://commons.apache.org/proper/commons-build-plugin/download_build-plugin.cgi + +----------------------------------------------------------------------------- diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 000000000..51943ba7b --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,17 @@ + +The Apache Commons security page is [https://commons.apache.org/security.html](https://commons.apache.org/security.html). diff --git a/pom.xml b/pom.xml index 1144caf34..82473c98c 100644 --- a/pom.xml +++ b/pom.xml @@ -1,4 +1,4 @@ - + + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/maven-v4_0_0.xsd"> 4.0.0 org.apache.commons commons-parent - 47 + 83 commons-build-plugin maven-plugin - 1.10 + 1.15.1-SNAPSHOT Apache Commons Build Plugin Maven Mojo Apache Maven Mojo for Apache Commons Build tasks. For example: - mvn commons:download-page [-Dcommons.release.version=1.2.3] + mvn commons-build:download-page [-Dcommons.release.version=1.2.3] To use a SNAPSHOT version (for testing etc) - mvn org.apache.commons:commons-build-plugin:1.10-SNAPSHOT:download-page [-Dcommons.release.version=1.2.3] + mvn org.apache.commons:commons-build-plugin:1.14.0-SNAPSHOT:download-page [-Dcommons.release.version=1.2.3] - http://commons.apache.org/proper/commons-build-plugin/ + https://commons.apache.org/proper/commons-build-plugin/ jira - http://issues.apache.org/jira/browse/COMMONSSITE + https://issues.apache.org/jira/browse/COMMONSSITE 2008 - scm:git:http://git-wip-us.apache.org/repos/asf/commons-build-plugin.git - scm:git:https://git-wip-us.apache.org/repos/asf/commons-build-plugin.git - https://git-wip-us.apache.org/repos/asf?p=commons-build-plugin.git + scm:git:http://gitbox.apache.org/repos/asf/commons-build-plugin.git + scm:git:https://gitbox.apache.org/repos/asf/commons-build-plugin.git + https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git + + GitHub + https://github.com/apache/commons-build-plugin/actions + commons.site @@ -54,42 +58,71 @@ scm:svn:${commons.scmPubUrl} - - - Niall Pemberton - niallp - niallp AT apache.org - - - Dennis Lundberg - dennisl - - - Gary Gregory - ggregory - ggregory AT apache.org - http://www.garygregory.com - -5 - - - + + true + 1.8 + 1.8 + + build-plugin + COMMONSSITE + 12310466&component=12312401 + commons-${commons.componentid} + https://svn.apache.org/repos/infra/websites/production/commons/content/proper/${commons.site.path} + site-content + + 1.14.1 + 1.15.0 + 1.15.1 + + RC1 + true + scm:svn:https://dist.apache.org/repos/dist/dev/commons/${commons.componentid} + 3.9.9 + + + true + + true + + true + + 2025-01-11T13:42:07Z + + + org.apache.ant + ant-launcher + 1.10.15 + + + org.apache.maven - maven-script-ant - 2.2.1 - - - + maven-plugin-api + ${commons.maven.version} + provided - org.apache.ant - ant-nodeps - 1.8.1 + + org.apache.maven + maven-core + ${commons.maven.version} + provided + + + org.apache.maven.plugin-tools + maven-script-ant + 3.15.1 - + + clean verify apache-rat:check spotbugs:check pmd:check pmd:cpd-check javadoc:javadoc site src/main/resources @@ -107,36 +140,24 @@ maven-plugin-plugin - 3.5.2 + 3.15.1 org.apache.maven.plugin-tools maven-plugin-tools-ant - 3.5.2 + 3.15.1 - commons-build - - - - pre-site - - report - - - target/plugin-generated-xdocs - - - maven-assembly-plugin + src/assembly/bin.xml src/assembly/src.xml gnu @@ -158,8 +179,13 @@ org.codehaus.mojo versions-maven-plugin - - 2.5 + + + com.github.spotbugs + spotbugs-maven-plugin + + + @@ -178,7 +204,17 @@ - + + org.apache.maven.plugins + maven-plugin-report-plugin + + + com.github.spotbugs + spotbugs-maven-plugin + + + + org.apache.maven.plugins @@ -187,42 +223,67 @@ - org.codehaus.mojo jdepend-maven-plugin - 2.0 + 2.1 - - true - 1.8 - 1.8 - - commons-build-plugin - COMMONSSITE - 12310466&component=12312401 - ${project.version} - RC1 - ${commons.componentid} - https://svn.apache.org/repos/infra/websites/production/commons/content/proper/${commons.site.path} - site-content - - - 1.9 - 1.10 - RC1 - true - scm:svn:https://dist.apache.org/repos/dist/dev/commons/${commons.componentid} - Rob Tompkins - B6E73D84EA4FCC47166087253FAAD2CD5ECBB314 - + + java-11 + + [11,17) + + + 22.3.3 + + + + org.graalvm.js + js + ${graalvm.version} + + + org.graalvm.js + js-scriptengine + ${graalvm.version} + + + + + java-17-plus + + [17,) + + + 24.2.1 + + + + org.graalvm.polyglot + js + ${graalvm.version} + import + pom + + + org.graalvm.polyglot + polyglot + ${graalvm.version} + + + org.graalvm.js + js-scriptengine + ${graalvm.version} + + + setup-checkout @@ -243,22 +304,20 @@ run - + - - - + @@ -267,4 +326,30 @@ + + + Niall Pemberton + niallp + niallp AT apache.org + + + Dennis Lundberg + dennisl + + + ggregory + Gary Gregory + ggregory at apache.org + https://www.garygregory.com + The Apache Software Foundation + https://www.apache.org/ + + PMC Member + + America/New_York + + https://people.apache.org/~ggregory/img/garydgregory80.png + + + diff --git a/src/assembly/bin.xml b/src/assembly/bin.xml new file mode 100644 index 000000000..3271f19f7 --- /dev/null +++ b/src/assembly/bin.xml @@ -0,0 +1,48 @@ + + + bin + + tar.gz + zip + + false + + + + LICENSE.txt + NOTICE.txt + RELEASE-NOTES.txt + README.md + CONTRIBUTING.md + + + + target + + + *.jar + + + + target/site/apidocs + apidocs + + + diff --git a/src/assembly/src.xml b/src/assembly/src.xml index 7a2b2ce5d..0cc392cc6 100644 --- a/src/assembly/src.xml +++ b/src/assembly/src.xml @@ -14,7 +14,9 @@ See the License for the specific language governing permissions and limitations under the License. --> - + src tar.gz @@ -28,8 +30,8 @@ LICENSE.txt NOTICE.txt pom.xml - RELEASE-NOTES.txt - README.md + RELEASE-NOTES.txt + README.md diff --git a/src/changes/changes.xml b/src/changes/changes.xml index fcc063d67..560ab3f72 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -1,106 +1,281 @@ - - - - - - - - Apache Commons Build Plugin Changes - Apache Commons Developers - - - - - - Use SHA512 signatures as the default in the download page. - - - Use SHA256 signatures as the default in the download page. - - - - - Fix in src/main/resources/commons-xdoc-templates/readme-md-template.md for components that have a major version number in their artifact IDs. - - - Add a goal for creating all items for pre-release. - - - Add a goal for creating the NOTICE.txt file. - - - Fix README.md generation typo: 'JavaDoc' -> 'Javadoc'. - - - Change the Maven goal prefix from "commons" to "commons-build". - - - Update platform requirement from Java 7 to Java 8. - - - - - Use sha1 signatures as opposed to md5 signatures in download page. - - - Include Javadoc badge in README.md file. - - - Add eol-style:native otherwise generated files can cause commit errors - - - - - Include badges in the README.md file. - - - Build plugin does not pass the JIRA_ID property when generating README.md. - - - - - - Added new download-page subdir property: set this (e.g. to '1.2' or 'lang-1.2' etc) to override the default of binaries/source - - - - - - commons-build-plugin README/CONTRIBUTING.md handle multi-modules - - - Download Page - Better describes KEYS file (and uses https links). - - - CONTRIBUTING.md/README.md - New Goals to build Markdown formatted intro files for GitHub. - - - - - - Add support for a "commons.release.3" set of properties to offer a 3rd download option. - - - Mailing List Page - Make it clear that you have to be subscribed to post. - - - Fix announce mod_mbox link - - - - + + + + + + + + Apache Commons Build Plugin Release Notes + Apache Commons Developers + + + + + Migrate site generation templates to https://maven.apache.org/xsd/xdoc-2.0.xsd. + Remove -nouses directive from maven-bundle-plugin. OSGi package imports now state 'uses' definitions for package imports, this doesn't affect JPMS (from org.apache.commons:commons-parent:80). + + Refactor version for Maven core plugin dependencies into a new property commons.maven.version. + Refactor unnamed profile into two for JavaScript dependency: java-11 and java-17-plus. + + Bump org.graalvm.js:js from 23.0.6 to 23.0.7 #347. + Bump graalvm.version from 24.1.2 to 24.2.1 #346, #357, #365 (when on Java 17 and up). + Bump org.apache.commons:commons-parent from 79 to 83 #367. + + + + Pick up maven-antrun-plugin version from parent POM org.apache:apache. + + Bump org.apache.commons:commons-parent from 78 to 79, upgrades Doxia from 1 to 2. + + + + Fix broken URL to project location in Maven Central #320. + + + Bump org.apache.commons:commons-parent from 69 to 78 #264, #276, #291, #301, #307, #312, #324. + Bump org.graalvm.js:js-scriptengine from 24.0.0 to 24.1.1 #248, #282, #308, #322. + Bump org.graalvm.js:js from 23.0.3 to 23.0.6 #247, #281, #321. + Bump org.apache.maven.plugin-tools:maven-plugin-tools-ant from 3.12.0 to 3.15.1 #260, #272, #292, #298. + Bump org.apache.maven.plugin-tools:maven-script-ant from 3.12.0 to 3.15.1 #259, #270, #295, #300. + Bump org.apache.maven.plugins:maven-plugin-plugin from 3.12.0 to 3.15.1 #258, #271, #299. + Bump org.apache.maven:maven-plugin-api from 3.9.6 to 3.9.9 #267, #277, #293. + Bump org.apache.maven:maven-core from 3.9.6 to 3.9.9 #268, #278, #294. + Bump org.apache.ant:ant-launcher from 1.10.14 to 1.10.15 #303. + Bump org.codehaus.mojo:jdepend-maven-plugin from 2.0 to 2.1 #311. + + Drop codecov.io badge. + + + + maven-plugin-report-plugin replaces maven-plugin-plugin report goal + Fix up errors in GHA badges for Java and CodeQL + Only use graalvm on Java11+; update to 22.3.3 which avoids NoClassDefFoundError messages + Replace mail-archives.apache.org with lists.apache.org + Drop mail archives that no longer exist (markmail, gmane, old.nabble) + Disable moditect as it fails currently + + Add Maven property project.build.outputTimestamp for build reproducibility. + + Bump org.apache.maven.plugins:maven-plugin-plugin from 3.10.2 to 3.11.0 + Drop IRC references + Bump commons-parent from 58 to 69 #240. + Bump org.apache.ant:ant-launcher from 1.10.12 to 1.10.14. + Disable cyclonedx - not needed + Drop outdated, unmaintained table of components in README in favour of link to website. + Bump org.graalvm.js:js-scriptengine from 23.1.0 to 24.0.0 #236. + Bump org.graalvm.js:js from 23.0.1 to 23.0.3. + Bump org.apache.maven:maven-core 3.9.4 to 3.9.6. + Bump org.apache.maven:maven-plugin-api 3.9.4 to 3.9.6. + Bump org.apache.maven.plugin-tools:maven-script-ant 3.9.0 to 3.12.0 #241. + Bump org.apache.maven.plugin-tools:maven-plugin-tools-ant from 3.9.0 to 3.12.0 #242. + Bump org.apache.maven.plugins:maven-artifact-plugin from 3.5.0 to 3.5.1 #393. + + + + + Fix running on Java 11 and up. Use GraalVM instead of Java 8 Nashorn for JavaScript, which was deprecated in Java 11 and removed in Java 15. + Unfortunately, you will see this output on the console at the end of a successful build: + + + Fix minor typos #79. + + + [StepSecurity] ci: Harden GitHub Actions #162. + + + + Add property commons.dist.subdir. + + + Add github/codeql-action. + + + + Bump Ant integration from org.apache.maven:maven-script-ant to org.apache.maven.plugin-tools:maven-script-ant 3.9.0. + + + Bump actions/cache. + + + Bump actions/checkout. + + + Bump actions/setup-java. + + + Bump actions/upload-artifact. + + + Bump github/codeql-action. + + + Bump maven-antrun-plugin from 1.8 to 3.1.0, #18, #71. + + + Bump spotbugs-maven-plugin from 4.1.3 to 4.7.3.0 #56, #58, #66, #73, #75, #77, #82, #93, #106. + + + Bump spotbugs from 4.1.3 to 4.7.3, #24, #26, #57, #63, #72, #80, #98. + + + Bump maven-plugin-plugin from 3.6.0 to 3.8.2, #33, #52, #61, #104, #127, #138, #154. + + + Bump maven-plugin-tools-ant from 3.6.0 to 3.9.0, #32, #53, #59, #126, #139, #152. + + + Bump versions-maven-plugin from 2.9.0 to 2.15.0 #64, #74, #81, #101. #115, #119. #136. + + + Bump commons-parent from 52 to 61 #67, #86, #110, #120, #153. + + + + + commons-build:mail-page - add links to lists.apache.org. + + + commons-build:all ignores commons.release.hash settings. + + + Enable GitHub build. + + + Update spotbugs-maven-plugin from 4.0.0 to 4.1.3, #7, #12, #15. + + + Update actions/checkout from v2.3.1 to v2.3.3 #9, #14, #21. + + + Update versions-maven-plugin from 2.7 to 2.8.1 #10. + + + Update actions/setup-java from v1.4.0 to v1.4.2 #13. + + + + + Update versions-maven-plugin 2.5 -> 2.7. + + + Update maven-plugin-plugin 3.5.2 -> 3.6.0. + + + Update maven-plugin-tools-ant 3.5.2 -> 3.6.0. + + + Update commons.release-plugin.version 1.5 -> 1.6. + + + Replace http://mail-archives.apache.org with https://mail-archives.apache.org. + + + + + Use SHA512 signatures as the default in the download page. + + + Use SHA256 signatures as the default in the download page. + + + + + Fix in src/main/resources/commons-xdoc-templates/readme-md-template.md for components that have a major version number in their artifact IDs. + + + Add a goal for creating all items for pre-release. + + + Add a goal for creating the NOTICE.txt file. + + + Fix README.md generation typo: 'JavaDoc' -> 'Javadoc'. + + + Change the Maven goal prefix from "commons" to "commons-build". + + + Update platform requirement from Java 7 to Java 8. + + + + + Use sha1 signatures as opposed to md5 signatures in download page. + + + Include Javadoc badge in README.md file. + + + Add eol-style:native otherwise generated files can cause commit errors + + + + + Include badges in the README.md file. + + + Build plugin does not pass the JIRA_ID property when generating README.md. + + + + + + Added new download-page subdir property: set this (e.g. to '1.2' or 'lang-1.2' etc) to override the default of binaries/source + + + + + + commons-build-plugin README/CONTRIBUTING.md handle multi-modules + + + Download Page - Better describes KEYS file (and uses https links). + + + CONTRIBUTING.md/README.md - New Goals to build Markdown formatted intro files for GitHub. + + + + + + Add support for a "commons.release.3" set of properties to offer a 3rd download option. + + + Mailing List Page - Make it clear that you have to be subscribed to post. + + + Fix announce mod_mbox link + + + + diff --git a/src/changes/release-notes.vm b/src/changes/release-notes.vm new file mode 100644 index 000000000..7ddaf3355 --- /dev/null +++ b/src/changes/release-notes.vm @@ -0,0 +1,118 @@ +## 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. +${project.name} ${version} RELEASE NOTES +----------------------------------------------------------- + +The Apache Commons team is pleased to announce ${project.name} ${version}. + +$introduction.replaceAll("(? - - - + + + - - - + + +
@FINAL_NAME@@BINARY-SUFFIX@.tar.gz@HASHLC@pgp@FINAL_NAME@@BINARY-SUFFIX@.tar.gz@HASHLC@pgp
@FINAL_NAME@@BINARY-SUFFIX@.zip@HASHLC@pgp@FINAL_NAME@@BINARY-SUFFIX@.zip@HASHLC@pgp
- - - + + + - - - + + +
@FINAL_NAME@-src.tar.gz@HASHLC@pgp@FINAL_NAME@-src.tar.gz@HASHLC@pgp
@FINAL_NAME@-src.zip@HASHLC@pgp@FINAL_NAME@-src.zip@HASHLC@pgp
diff --git a/src/main/resources/commons-xdoc-templates/download-page-foot.xml b/src/main/resources/commons-xdoc-templates/download-page-foot.xml index 48cb029f1..9e371407e 100644 --- a/src/main/resources/commons-xdoc-templates/download-page-foot.xml +++ b/src/main/resources/commons-xdoc-templates/download-page-foot.xml @@ -3,8 +3,8 @@ Older releases can be obtained from the archives.

diff --git a/src/main/resources/commons-xdoc-templates/download-page-head.xml b/src/main/resources/commons-xdoc-templates/download-page-head.xml index b8ab04ae8..7b2e41e84 100644 --- a/src/main/resources/commons-xdoc-templates/download-page-head.xml +++ b/src/main/resources/commons-xdoc-templates/download-page-head.xml @@ -1,115 +1,117 @@ - - - - - - Download @NAME@ - Apache Commons Documentation Team - - -
- -

- We recommend you use a mirror to download our release - builds, but you must verify the integrity of - the downloaded files using signatures downloaded from our main - distribution directories. Recent releases (48 hours) may not yet - be available from all the mirrors. -

- -

- You are currently using [preferred]. If you - encounter a problem with this mirror, please select another - mirror. If all mirrors are failing, there are backup - mirrors (at the end of the mirrors list) that should be - available. -

- [if-any logo][end] -

- -
-

- Other mirrors: - - -

-
- -

- It is essential that you - verify the integrity - of downloaded files, preferably using the PGP signature (*.asc files); - failing that using the @HASHUC@ hash (*.@HASHLC@ checksum files). -

-

- The KEYS - file contains the public PGP keys used by Apache Commons developers - to sign releases. -

- -
+ + + + + + Download @NAME@ + Apache Commons Team + + +
+ +

+ We recommend you use a mirror to download our release + builds, but you must verify the integrity of + the downloaded files using signatures downloaded from our main + distribution directories. Recent releases (48 hours) may not yet + be available from all the mirrors. +

+ +

+ You are currently using [preferred]. If you + encounter a problem with this mirror, please select another + mirror. If all mirrors are failing, there are backup + mirrors (at the end of the mirrors list) that should be + available. +

+ [if-any logo]Logo[end] +

+ +
+

+ Other mirrors: + + +

+
+ +

+ It is essential that you + verify the integrity + of downloaded files, preferably using the PGP signature (*.asc files); + failing that using the @HASHUC@ hash (*.@HASHLC@ checksum files). +

+

+ The KEYS + file contains the public PGP keys used by Apache Commons developers + to sign releases. +

+ +
diff --git a/src/main/resources/commons-xdoc-templates/issue-tracking-template.xml b/src/main/resources/commons-xdoc-templates/issue-tracking-template.xml index 89d905540..1b9e4ea2f 100644 --- a/src/main/resources/commons-xdoc-templates/issue-tracking-template.xml +++ b/src/main/resources/commons-xdoc-templates/issue-tracking-template.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. | | +======================================================================+ --> - + @NAME@ Issue tracking - Apache Commons Documentation Team + Apache Commons Team @@ -64,6 +66,7 @@ limitations under the License.

If you would like to report a bug, or raise an enhancement request with @NAME@ please do the following: +

  1. Search existing open bugs. If you find your issue listed then please add a comment with your details.
    2. @@ -73,30 +76,29 @@ limitations under the License.
  2. Submit either a bug report or enhancement request.
-

Please also remember these points: +

  • the more information you provide, the better we can help you
  • test cases are vital, particularly for any proposed enhancements
  • the developers of @NAME@ are all unpaid volunteers
-

- For more information on subversion and creating patches see the - Apache Contributors Guide. + For more information on creating patches see the + Apache Contributors Guide.

You may also find these links useful: +

-

diff --git a/src/main/resources/commons-xdoc-templates/mail-lists-template.xml b/src/main/resources/commons-xdoc-templates/mail-lists-template.xml index c0f083c97..7e9fbffdb 100644 --- a/src/main/resources/commons-xdoc-templates/mail-lists-template.xml +++ b/src/main/resources/commons-xdoc-templates/mail-lists-template.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,29 +39,31 @@ limitations under the License. | | +======================================================================+ --> - + @NAME@ Mailing Lists - Apache Commons Documentation Team + Apache Commons Team

@NAME@ shares mailing lists with all the other - Commons Components. + Commons Components. 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: -

    -
  • [@ID@] Problem with the ...
    • -

+
    +
  • [@ID@] Problem with the ...
    • +

Questions related to the usage of @NAME@ should be posted to the - User List. + User List.
- The Developer List + The Developer List is for questions and discussion related to the development of @NAME@.
Please do not cross-post; developers are also subscribed to the user list. @@ -70,8 +72,10 @@ limitations under the License. to subscribe.

- Note: please don't send patches or attachments to any of the mailing lists. + Note: please don't send patches or attachments to any of the mailing lists; + most of the lists are set up to drop attachments. Patches are best handled via the Issue Tracking system. + If you have a GitHub account, most components also accept PRs (pull requests). Otherwise, please upload the file to a public server and include the URL in the mail.

@@ -105,10 +109,11 @@ limitations under the License. Subscribe Unsubscribe Post - mail-archives.apache.org - markmail.org
- www.mail-archive.com
- news.gmane.org + + lists.apache.org + + + www.mail-archive.com @@ -123,10 +128,11 @@ limitations under the License. Subscribe Unsubscribe Post - mail-archives.apache.org - markmail.org
- www.mail-archive.com
- news.gmane.org + + lists.apache.org + + + www.mail-archive.com @@ -141,9 +147,11 @@ limitations under the License. Subscribe Unsubscribe read only - mail-archives.apache.org - markmail.org
- www.mail-archive.com + + lists.apache.org + + + www.mail-archive.com @@ -152,15 +160,17 @@ limitations under the License. Commons Commits List

- Only for e-mails automatically generated by the source control sytem. + Only for e-mails automatically generated by the source control system.

Subscribe Unsubscribe read only - mail-archives.apache.org - markmail.org
- www.mail-archive.com + + lists.apache.org + + + www.mail-archive.com @@ -191,11 +201,11 @@ limitations under the License. Subscribe Unsubscribe read only - mail-archives.apache.org - markmail.org
- old.nabble.com
- www.mail-archive.com
- news.gmane.org + + lists.apache.org + + + www.mail-archive.com diff --git a/src/main/resources/commons-xdoc-templates/no-download-page-template.xml b/src/main/resources/commons-xdoc-templates/no-download-page-template.xml index 0496135c2..19f080be7 100644 --- a/src/main/resources/commons-xdoc-templates/no-download-page-template.xml +++ b/src/main/resources/commons-xdoc-templates/no-download-page-template.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, @@ -30,23 +30,22 @@ limitations under the License. | | | 2) Set the following properties in the component's pom: | | - commons.componentid (required, alphabetic, lower case) | - | - commons.release.version (required) | - | - commons.binary.suffix (optional) | - | (defaults to "-bin", set to "" for pre-maven2 releases) | + | This template is used if commons.release.version is undefined. | | | | 3) Example Properties | | | | | | math | - | 1.2 | | | | | +======================================================================+ --> - + Download @NAME@ - Apache Commons Documentation Team + Apache Commons Team
diff --git a/src/main/resources/commons-xdoc-templates/notice-txt-template.txt b/src/main/resources/commons-xdoc-templates/notice-txt-template.txt index 72e7b7cef..63c0c086c 100644 --- a/src/main/resources/commons-xdoc-templates/notice-txt-template.txt +++ b/src/main/resources/commons-xdoc-templates/notice-txt-template.txt @@ -2,4 +2,4 @@ Copyright @INCEPTIONYEAR@-@CURRENTYEAR@ The Apache Software Foundation This product includes software developed at -The Apache Software Foundation (http://www.apache.org/). +The Apache Software Foundation (https://www.apache.org/). 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 709eafcf8..7caaf8eaf 100644 --- a/src/main/resources/commons-xdoc-templates/readme-md-template.md +++ b/src/main/resources/commons-xdoc-templates/readme-md-template.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, @@ -43,10 +43,11 @@ @NAME@ =================== -[![Build Status](https://travis-ci.org/apache/commons-@ID@.svg)](https://travis-ci.org/apache/commons-@ID@) -[![Coverage Status](https://coveralls.io/repos/apache/commons-@ID@/badge.svg)](https://coveralls.io/r/apache/commons-@ID@) -[![Maven Central](https://maven-badges.herokuapp.com/maven-central/@GROUPID@/@ARTIFACTCOREID@/badge.svg)](https://maven-badges.herokuapp.com/maven-central/@GROUPID@/@ARTIFACTCOREID@/) +[![Java CI](https://github.com/apache/commons-@ID@/actions/workflows/maven.yml/badge.svg)](https://github.com/apache/commons-@ID@/actions/workflows/maven.yml) +[![Maven Central](https://img.shields.io/maven-central/v/@GROUPID@/@ARTIFACTCOREID@?label=Maven%20Central)](https://search.maven.org/artifact/@GROUPID@/@ARTIFACTCOREID@) [![Javadocs](https://javadoc.io/badge/@GROUPID@/@ARTIFACTCOREID@/@VERSION@.svg)](https://javadoc.io/doc/@GROUPID@/@ARTIFACTCOREID@/@VERSION@) +[![CodeQL](https://github.com/apache/commons-@ID@/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/apache/commons-@ID@/actions/workflows/codeql-analysis.yml) +[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/apache/commons-@ID@/badge)](https://api.securityscorecards.dev/projects/github.com/apache/commons-@ID@) @DESCRIPTION@ @@ -55,13 +56,13 @@ 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]. +Questions related to the usage of @NAME@ should be posted to the [user mailing list](https://commons.apache.org/mail-lists.html). -Where can I get the latest release? ------------------------------------ +Getting 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: +Alternatively, you can pull it from the central Maven repositories: ```xml @@ -71,35 +72,48 @@ Alternatively you can pull it from the central Maven repositories: ``` +Building +-------- + +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. + Contributing ------------ -We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors. +We accept Pull Requests via GitHub. The [developer mailing list](https://commons.apache.org/mail-lists.html) 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. ++ 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 clean test```. ++ 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). License ------- -This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0). +This code is licensed under the [Apache License 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. +Donating +-------- +You like @NAME@? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support development. Additional Resources -------------------- + [Apache Commons Homepage](https://commons.apache.org/) + [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/@JIRA_ID@) ++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD) + [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) -+ `#apache-commons` IRC channel on `irc.freenode.org` -[ml]:https://commons.apache.org/mail-lists.html +Apache Commons Components +------------------------- + +Please see the [list of components](https://commons.apache.org/components.html) diff --git a/src/main/resources/commons-xdoc-templates/sandbox-issue-tracking-template.xml b/src/main/resources/commons-xdoc-templates/sandbox-issue-tracking-template.xml index 8972eddbe..ed8414043 100644 --- a/src/main/resources/commons-xdoc-templates/sandbox-issue-tracking-template.xml +++ b/src/main/resources/commons-xdoc-templates/sandbox-issue-tracking-template.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,62 +39,64 @@ limitations under the License. | | +======================================================================+ --> - + @NAME@ Issue tracking - Apache Commons Documentation Team + Apache Commons Team

- @NAME@ uses ASF JIRA for tracking issues. - See the Sandbox JIRA project page. + @NAME@ uses ASF JIRA for tracking issues. + See the Sandbox JIRA project page.

- To use JIRA you may need to create an account + To use JIRA you may need to create an account (if you have previously created/updated Commons issues using Bugzilla an account will have been automatically - created and you can use the Forgot Password + created and you can use the Forgot Password page to get a new password).

If you would like to report a bug, or raise an enhancement request with @NAME@ please do the following: +

    -
  1. Search existing open bugs. +
  2. Search existing open bugs. If you find your issue listed then please add a comment with your details.
  3. Search the mailing list archive(s). You may find your issue or idea has already been discussed.
  4. Decide if your issue is a bug or an enhancement.
    5. -
  5. Submit either a bug report - or enhancement request.
    6. +
  6. Submit either a bug report + or enhancement request.
-

Please also remember these points: +

  • the more information you provide, the better we can help you
  • test cases are vital, particularly for any proposed enhancements
  • the developers of @NAME@ are all unpaid volunteers
-

- For more information on subversion and creating patches see the - Apache Contributors Guide. + For more information on creating patches see the + Apache Contributors Guide.

You may also find these links useful: +

-

diff --git a/src/main/scripts/copy-javadoc-files.build.xml b/src/main/scripts/copy-javadoc-files.build.xml index 4389dfa06..dcfb7e492 100644 --- a/src/main/scripts/copy-javadoc-files.build.xml +++ b/src/main/scripts/copy-javadoc-files.build.xml @@ -5,9 +5,9 @@ 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. diff --git a/src/main/scripts/copy-javadoc-files.mojos.xml b/src/main/scripts/copy-javadoc-files.mojos.xml index 5659ba120..9b781503f 100644 --- a/src/main/scripts/copy-javadoc-files.mojos.xml +++ b/src/main/scripts/copy-javadoc-files.mojos.xml @@ -19,7 +19,10 @@ - + copy-javadoc-files diff --git a/src/main/scripts/generate-xdocs.build.xml b/src/main/scripts/generate-xdocs.build.xml index 7528bf0ad..20873a860 100644 --- a/src/main/scripts/generate-xdocs.build.xml +++ b/src/main/scripts/generate-xdocs.build.xml @@ -1,555 +1,575 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - project.setProperty( attributes.get( "to" ), - attributes.get( "string" ).toUpperCase() ); - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + project.setProperty( attributes.get( "to" ), + attributes.get( "string" ).toUpperCase() ); + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/main/scripts/generate-xdocs.mojos.xml b/src/main/scripts/generate-xdocs.mojos.xml index a35b09f4b..b355d2f4d 100644 --- a/src/main/scripts/generate-xdocs.mojos.xml +++ b/src/main/scripts/generate-xdocs.mojos.xml @@ -1,1016 +1,1100 @@ - - - - - - - - all - all - Apache Commons Build Mojo: Generate all pages. - true - - - project.name - project.name - true - true - ${project.name} - java.lang.String - The name of the project currently being built. - - - project.description - project.description - true - true - ${project.description} - java.lang.String - A description of the project currently being built. - - - project.groupId - project.groupId - true - true - ${project.groupId} - java.lang.String - The groupId of the project currently being built. - - - project.artifactId - project.artifactId - true - true - ${project.artifactId} - java.lang.String - The artifactId of the project currently being built. - - - project.inceptionYear - project.inceptionYear - true - true - ${project.inceptionYear} - java.lang.String - The inception year of the project currently being built. - - - commons.jira.id - commons.jira.id - true - false - ${commons.jira.id} - java.lang.String - The external JIRA id for the project (alphabetic, upper case.) - - - commons.componentid - commons.componentid - true - true - ${commons.componentid} - java.lang.String - The commons component id. - - - commons.jira.pid - commons.jira.pid - true - false - ${commons.jira.pid} - java.lang.String - The internal JIRA id for the project (numeric.) - - - commons.release.version - commons.release.version - true - false - ${commons.release.version} - java.lang.String - The version of the latest release of the project. - - - commons.release.name - commons.release.name - true - false - ${commons.release.name} - java.lang.String - The name of the latest release of the project. - - - commons.binary.suffix - commons.binary.suffix - false - false - ${commons.binary.suffix} - java.lang.String - The suffix for the binary distribution. - - - commons.release.desc - commons.release.desc - false - false - ${commons.release.desc} - java.lang.String - Release Title or Description. - - - commons.release.subdir - commons.release.subdir - false - false - ${commons.release.subdir} - java.lang.String - Subdirectory (instead of source/binaries.) - - - - commons.release.2.version - commons.release.2.version - false - false - ${commons.release.2.version} - java.lang.String - The version of an alternative release of the project. - - - commons.release.2.name - commons.release.2.name - true - false - ${commons.release.2.name} - java.lang.String - The name of the alternative release of the project. - - - commons.release.2.desc - commons.release.2.desc - false - false - ${commons.release.2.desc} - java.lang.String - Alternative Release Title or Description. - - - commons.release.2.binary.suffix - commons.release.2.binary.suffix - false - false - ${commons.release.2.binary.suffix} - java.lang.String - The suffix for the alternative release binary distribution. - - - commons.release.2.subdir - commons.release.2.subdir - false - false - ${commons.release.2.subdir} - java.lang.String - Subdirectory (instead of source/binaries.) - - - - commons.release.3.version - commons.release.3.version - false - false - ${commons.release.3.version} - java.lang.String - The version of an alternative release of the project. - - - commons.release.3.name - commons.release.3.name - true - false - ${commons.release.3.name} - java.lang.String - The name of the alternative release of the project. - - - commons.release.3.desc - commons.release.3.desc - false - false - ${commons.release.3.desc} - java.lang.String - Alternative Release Title or Description. - - - commons.release.3.binary.suffix - commons.release.3.binary.suffix - false - false - ${commons.release.3.binary.suffix} - java.lang.String - The suffix for the alternative release binary distribution. - - - commons.release.3.subdir - commons.release.3.subdir - false - false - ${commons.release.3.subdir} - java.lang.String - Subdirectory (instead of source/binaries.) - - - - commons.release.4.version - commons.release.4.version - false - false - ${commons.release.4.version} - java.lang.String - The version of an alternative release of the project. - - - commons.release.4.name - commons.release.4.name - true - false - ${commons.release.4.name} - java.lang.String - The name of the alternative release of the project. - - - commons.release.4.desc - commons.release.4.desc - false - false - ${commons.release.4.desc} - java.lang.String - Alternative Release Title or Description. - - - commons.release.4.binary.suffix - commons.release.4.binary.suffix - false - false - ${commons.release.4.binary.suffix} - java.lang.String - The suffix for the alternative release binary distribution. - - - commons.release.4.subdir - commons.release.4.subdir - false - false - ${commons.release.4.subdir} - java.lang.String - Subdirectory (instead of source/binaries.) - - - - - all-sandbox - all-sandbox - Apache Commons Build Mojo: Generate all sandbox pages. - true - - - project.name - project.name - true - true - ${project.name} - java.lang.String - The name of the project currently being built. - - - project.groupId - project.groupId - true - true - ${project.groupId} - java.lang.String - The groupId of the project currently being built. - - - project.artifactId - project.artifactId - true - true - ${project.artifactId} - java.lang.String - The artifactId of the project currently being built. - - - commons.jira.id - commons.jira.id - true - false - ${commons.jira.id} - java.lang.String - The external JIRA id for the project (alphabetic, upper case.) - - - commons.componentid - commons.componentid - true - true - ${commons.componentid} - java.lang.String - The commons component id. - - - commons.jira.pid - commons.jira.pid - true - false - ${commons.jira.pid} - java.lang.String - The internal JIRA id for the project (numeric.) - - - commons.release.version - commons.release.version - true - false - ${commons.release.version} - java.lang.String - The version of the latest release of the project. - - - commons.release.name - commons.release.name - true - false - ${commons.release.name} - java.lang.String - The name of the latest release of the project. - - - commons.binary.suffix - commons.binary.suffix - false - false - ${commons.binary.suffix} - java.lang.String - The suffix for the binary distribution. - - - commons.release.desc - commons.release.desc - false - false - ${commons.release.desc} - java.lang.String - Release Title or Description. - - - commons.release.subdir - commons.release.subdir - false - false - ${commons.release.subdir} - java.lang.String - Subdirectory (instead of source/binaries.) - - - - commons.release.2.version - commons.release.2.version - false - false - ${commons.release.2.version} - java.lang.String - The version of an alternative release of the project. - - - commons.release.2.name - commons.release.2.name - true - false - ${commons.release.2.name} - java.lang.String - The name of the alternative release of the project. - - - commons.release.2.desc - commons.release.2.desc - false - false - ${commons.release.2.desc} - java.lang.String - Alternative Release Title or Description. - - - commons.release.2.binary.suffix - commons.release.2.binary.suffix - false - false - ${commons.release.2.binary.suffix} - java.lang.String - The suffix for the alternative release binary distribution. - - - commons.release.2.subdir - commons.release.2.subdir - false - false - ${commons.release.2.subdir} - java.lang.String - Subdirectory (instead of source/binaries.) - - - - commons.release.3.version - commons.release.3.version - false - false - ${commons.release.3.version} - java.lang.String - The version of an alternative release of the project. - - - commons.release.3.name - commons.release.3.name - true - false - ${commons.release.3.name} - java.lang.String - The name of the alternative release of the project. - - - commons.release.3.desc - commons.release.3.desc - false - false - ${commons.release.3.desc} - java.lang.String - Alternative Release Title or Description. - - - commons.release.3.binary.suffix - commons.release.3.binary.suffix - false - false - ${commons.release.3.binary.suffix} - java.lang.String - The suffix for the alternative release binary distribution. - - - commons.release.3.subdir - commons.release.3.subdir - false - false - ${commons.release.3.subdir} - java.lang.String - Subdirectory (instead of source/binaries.) - - - - commons.release.4.version - commons.release.4.version - false - false - ${commons.release.4.version} - java.lang.String - The version of an alternative release of the project. - - - commons.release.4.name - commons.release.4.name - true - false - ${commons.release.4.name} - java.lang.String - The name of the alternative release of the project. - - - commons.release.4.desc - commons.release.4.desc - false - false - ${commons.release.4.desc} - java.lang.String - Alternative Release Title or Description. - - - commons.release.4.binary.suffix - commons.release.4.binary.suffix - false - false - ${commons.release.4.binary.suffix} - java.lang.String - The suffix for the alternative release binary distribution. - - - commons.release.4.subdir - commons.release.4.subdir - false - false - ${commons.release.4.subdir} - java.lang.String - Subdirectory (instead of source/binaries.) - - - - - mail-page - mail-page - Apache Commons Build Mojo: Generate Mailing List page. - true - - - project.name - project.name - true - true - ${project.name} - java.lang.String - The name of the project currently being built. - - - commons.componentid - commons.componentid - true - true - ${commons.componentid} - java.lang.String - The commons component id. - - - - - jira-page - jira-page - Apache Commons Build Mojo: Generate Issue Tracking page. - true - - - project.name - project.name - true - true - ${project.name} - java.lang.String - The name of the project currently being built. - - - commons.jira.id - commons.jira.id - true - false - ${commons.jira.id} - java.lang.String - The external JIRA id for the project (alphabetic, upper case.) - - - commons.jira.pid - commons.jira.pid - true - false - ${commons.jira.pid} - java.lang.String - The internal JIRA id for the project (numeric.) - - - - - sandbox-jira-page - sandbox-jira-page - Apache Commons Build Mojo: Generate Sandbox Issue Tracking page. - true - - - project.name - project.name - true - true - ${project.name} - java.lang.String - The name of the project currently being built. - - - commons.jira.componentid - commons.jira.componentid - true - false - ${commons.jira.componentid} - java.lang.String - The internal JIRA component id (numeric.) - - - - - download-page - download-page - Apache Commons Build Mojo: Generate Download page. - true - - - project.name - project.name - true - true - ${project.name} - java.lang.String - The name of the project currently being built. - - - project.artifactId - project.artifactId - true - true - ${project.artifactId} - java.lang.String - The artifactId of the project currently being built. - - - commons.componentid - commons.componentid - true - true - ${commons.componentid} - java.lang.String - The commons component id. - - - commons.release.version - commons.release.version - true - false - ${commons.release.version} - java.lang.String - The version of the latest release of the project. - - - commons.release.name - commons.release.name - true - false - ${commons.release.name} - java.lang.String - The name of the latest release of the project. - - - commons.binary.suffix - commons.binary.suffix - false - false - ${commons.binary.suffix} - java.lang.String - The suffix for the binary distribution. - - - commons.release.desc - commons.release.desc - false - false - ${commons.release.desc} - java.lang.String - Release Title or Description. - - - commons.release.subdir - commons.release.subdir - false - false - ${commons.release.subdir} - java.lang.String - Subdirectory (instead of source/binaries.) - - - commons.release.hash - commons.release.hash - false - false - ${commons.release.hash} - java.lang.String - Type of hash (lower case, e.g. sha512) - - - - commons.release.2.version - commons.release.2.version - false - false - ${commons.release.2.version} - java.lang.String - The version of an alternative release of the project. - - - commons.release.2.name - commons.release.2.name - true - false - ${commons.release.2.name} - java.lang.String - The name of the alternative release of the project. - - - commons.release.2.desc - commons.release.2.desc - false - false - ${commons.release.2.desc} - java.lang.String - Alternative Release Title or Description. - - - commons.release.2.binary.suffix - commons.release.2.binary.suffix - false - false - ${commons.release.2.binary.suffix} - java.lang.String - The suffix for the alternative release binary distribution. - - - commons.release.2.subdir - commons.release.2.subdir - false - false - ${commons.release.2.subdir} - java.lang.String - Subdirectory (instead of source/binaries.) - - - commons.release.2.hash - commons.release.2.hash - false - false - ${commons.release.2.hash} - java.lang.String - Type of hash (lower case, e.g. sha512) - - - - commons.release.3.version - commons.release.3.version - false - false - ${commons.release.3.version} - java.lang.String - The version of an alternative release of the project. - - - commons.release.3.name - commons.release.3.name - true - false - ${commons.release.3.name} - java.lang.String - The name of the alternative release of the project. - - - commons.release.3.desc - commons.release.3.desc - false - false - ${commons.release.3.desc} - java.lang.String - Alternative Release Title or Description. - - - commons.release.3.binary.suffix - commons.release.3.binary.suffix - false - false - ${commons.release.3.binary.suffix} - java.lang.String - The suffix for the alternative release binary distribution. - - - commons.release.3.subdir - commons.release.3.subdir - false - false - ${commons.release.3.subdir} - java.lang.String - Subdirectory (instead of source/binaries.) - - - commons.release.3.hash - commons.release.3.hash - false - false - ${commons.release.3.hash} - java.lang.String - Type of hash (lower case, e.g. sha512) - - - - commons.release.4.version - commons.release.4.version - false - false - ${commons.release.4.version} - java.lang.String - The version of an alternative release of the project. - - - commons.release.4.name - commons.release.4.name - true - false - ${commons.release.4.name} - java.lang.String - The name of the alternative release of the project. - - - commons.release.4.desc - commons.release.4.desc - false - false - ${commons.release.4.desc} - java.lang.String - Alternative Release Title or Description. - - - commons.release.4.binary.suffix - commons.release.4.binary.suffix - false - false - ${commons.release.4.binary.suffix} - java.lang.String - The suffix for the alternative release binary distribution. - - - commons.release.4.subdir - commons.release.4.subdir - false - false - ${commons.release.4.subdir} - java.lang.String - Subdirectory (instead of source/binaries.) - - - commons.release.4.hash - commons.release.4.hash - false - false - ${commons.release.4.hash} - java.lang.String - Type of hash (lower case, e.g. sha512) - - - - - readme-md - readme-md - Apache Commons Build Mojo: Generate README.md. - true - - - project.name - project.name - true - true - ${project.name} - java.lang.String - The name of the project currently being built. - - - project.description - project.description - true - true - ${project.description} - java.lang.String - A description of the project currently being built. - - - project.artifactId - project.artifactId - true - true - ${project.artifactId} - java.lang.String - The artifactId of the project currently being built. - - - project.groupId - project.groupId - true - true - ${project.groupId} - java.lang.String - The groupId of the project currently being built. - - - commons.jira.id - commons.jira.id - true - false - ${commons.jira.id} - java.lang.String - The external JIRA id for the project (alphabetic, upper case.) - - - commons.release.version - commons.release.version - true - false - ${commons.release.version} - java.lang.String - The version of the latest release of the project. - - - commons.componentid - commons.componentid - true - true - ${commons.componentid} - java.lang.String - The commons component id. - - - - - notice-txt - notice-txt - Apache Commons Build Mojo: Generate NOTICE.txt. - true - - - project.name - project.name - true - true - ${project.name} - java.lang.String - The name of the project currently being built. - - - project.inceptionYear - project.inceptionYear - true - true - ${project.inceptionYear} - java.lang.String - The inception year of the project currently being built. - - - - - contributing-md - contributing-md - Apache Commons Build Mojo: Generate CONTRIBUTING.md. - true - - - project.name - project.name - true - true - ${project.name} - java.lang.String - The name of the project currently being built. - - - project.artifactId - project.artifactId - true - true - ${project.artifactId} - java.lang.String - The artifactId of the project currently being built. - - - commons.jira.id - commons.jira.id - true - false - ${commons.jira.id} - java.lang.String - The external JIRA id for the project (alphabetic, upper case.) - - - commons.componentid - commons.componentid - true - true - ${commons.componentid} - java.lang.String - The commons component id. - - - - - + + + + + + + + all + all + Apache Commons Build Mojo: Generate all pages. + true + + + project.name + project.name + true + true + ${project.name} + java.lang.String + The name of the project currently being built. + + + project.description + project.description + true + true + ${project.description} + java.lang.String + A description of the project currently being built. + + + project.groupId + project.groupId + true + true + ${project.groupId} + java.lang.String + The groupId of the project currently being built. + + + project.artifactId + project.artifactId + true + true + ${project.artifactId} + java.lang.String + The artifactId of the project currently being built. + + + project.inceptionYear + project.inceptionYear + true + true + ${project.inceptionYear} + java.lang.String + The inception year of the project currently being built. + + + commons.jira.id + commons.jira.id + true + false + ${commons.jira.id} + java.lang.String + The external JIRA id for the project (alphabetic, upper case.) + + + commons.componentid + commons.componentid + true + true + ${commons.componentid} + java.lang.String + The commons component id. + + + commons.dist.subdir + commons.dist.subdir + false + false + ${commons.dist.subdir} + java.lang.String + The folder in commons for this component. + + + commons.jira.pid + commons.jira.pid + true + false + ${commons.jira.pid} + java.lang.String + The internal JIRA id for the project (numeric.) + + + commons.release.version + commons.release.version + true + false + ${commons.release.version} + java.lang.String + The version of the latest release of the project. + + + commons.release.name + commons.release.name + true + false + ${commons.release.name} + java.lang.String + The name of the latest release of the project. + + + commons.binary.suffix + commons.binary.suffix + false + false + ${commons.binary.suffix} + java.lang.String + The suffix for the binary distribution. + + + commons.release.desc + commons.release.desc + false + false + ${commons.release.desc} + java.lang.String + Release Title or Description. + + + commons.release.subdir + commons.release.subdir + false + false + ${commons.release.subdir} + java.lang.String + Subdirectory (instead of source/binaries.) + + + commons.release.hash + commons.release.hash + false + false + ${commons.release.hash} + java.lang.String + Type of hash (lower case, e.g. sha512) + + + + commons.release.2.version + commons.release.2.version + false + false + ${commons.release.2.version} + java.lang.String + The version of an alternative release of the project. + + + commons.release.2.name + commons.release.2.name + true + false + ${commons.release.2.name} + java.lang.String + The name of the alternative release of the project. + + + commons.release.2.desc + commons.release.2.desc + false + false + ${commons.release.2.desc} + java.lang.String + Alternative Release Title or Description. + + + commons.release.2.binary.suffix + commons.release.2.binary.suffix + false + false + ${commons.release.2.binary.suffix} + java.lang.String + The suffix for the alternative release binary distribution. + + + commons.release.2.subdir + commons.release.2.subdir + false + false + ${commons.release.2.subdir} + java.lang.String + Subdirectory (instead of source/binaries.) + + + commons.release.2.hash + commons.release.2.hash + false + false + ${commons.release.2.hash} + java.lang.String + Type of hash (lower case, e.g. sha512) + + + + commons.release.3.version + commons.release.3.version + false + false + ${commons.release.3.version} + java.lang.String + The version of an alternative release of the project. + + + commons.release.3.name + commons.release.3.name + true + false + ${commons.release.3.name} + java.lang.String + The name of the alternative release of the project. + + + commons.release.3.desc + commons.release.3.desc + false + false + ${commons.release.3.desc} + java.lang.String + Alternative Release Title or Description. + + + commons.release.3.binary.suffix + commons.release.3.binary.suffix + false + false + ${commons.release.3.binary.suffix} + java.lang.String + The suffix for the alternative release binary distribution. + + + commons.release.3.subdir + commons.release.3.subdir + false + false + ${commons.release.3.subdir} + java.lang.String + Subdirectory (instead of source/binaries.) + + + commons.release.3.hash + commons.release.3.hash + false + false + ${commons.release.3.hash} + java.lang.String + Type of hash (lower case, e.g. sha512) + + + + commons.release.4.version + commons.release.4.version + false + false + ${commons.release.4.version} + java.lang.String + The version of an alternative release of the project. + + + commons.release.4.name + commons.release.4.name + true + false + ${commons.release.4.name} + java.lang.String + The name of the alternative release of the project. + + + commons.release.4.desc + commons.release.4.desc + false + false + ${commons.release.4.desc} + java.lang.String + Alternative Release Title or Description. + + + commons.release.4.binary.suffix + commons.release.4.binary.suffix + false + false + ${commons.release.4.binary.suffix} + java.lang.String + The suffix for the alternative release binary distribution. + + + commons.release.4.subdir + commons.release.4.subdir + false + false + ${commons.release.4.subdir} + java.lang.String + Subdirectory (instead of source/binaries.) + + + commons.release.4.hash + commons.release.4.hash + false + false + ${commons.release.4.hash} + java.lang.String + Type of hash (lower case, e.g. sha512) + + + + + all-sandbox + all-sandbox + Apache Commons Build Mojo: Generate all sandbox pages. + true + + + project.name + project.name + true + true + ${project.name} + java.lang.String + The name of the project currently being built. + + + project.groupId + project.groupId + true + true + ${project.groupId} + java.lang.String + The groupId of the project currently being built. + + + project.artifactId + project.artifactId + true + true + ${project.artifactId} + java.lang.String + The artifactId of the project currently being built. + + + commons.jira.id + commons.jira.id + true + false + ${commons.jira.id} + java.lang.String + The external JIRA id for the project (alphabetic, upper case.) + + + commons.componentid + commons.componentid + true + true + ${commons.componentid} + java.lang.String + The commons component id. + + + commons.jira.pid + commons.jira.pid + true + false + ${commons.jira.pid} + java.lang.String + The internal JIRA id for the project (numeric.) + + + commons.release.version + commons.release.version + true + false + ${commons.release.version} + java.lang.String + The version of the latest release of the project. + + + commons.release.name + commons.release.name + true + false + ${commons.release.name} + java.lang.String + The name of the latest release of the project. + + + commons.binary.suffix + commons.binary.suffix + false + false + ${commons.binary.suffix} + java.lang.String + The suffix for the binary distribution. + + + commons.release.desc + commons.release.desc + false + false + ${commons.release.desc} + java.lang.String + Release Title or Description. + + + commons.release.subdir + commons.release.subdir + false + false + ${commons.release.subdir} + java.lang.String + Subdirectory (instead of source/binaries.) + + + commons.release.hash + commons.release.hash + false + false + ${commons.release.hash} + java.lang.String + Type of hash (lower case, e.g. sha512) + + + + commons.release.2.version + commons.release.2.version + false + false + ${commons.release.2.version} + java.lang.String + The version of an alternative release of the project. + + + commons.release.2.name + commons.release.2.name + true + false + ${commons.release.2.name} + java.lang.String + The name of the alternative release of the project. + + + commons.release.2.desc + commons.release.2.desc + false + false + ${commons.release.2.desc} + java.lang.String + Alternative Release Title or Description. + + + commons.release.2.binary.suffix + commons.release.2.binary.suffix + false + false + ${commons.release.2.binary.suffix} + java.lang.String + The suffix for the alternative release binary distribution. + + + commons.release.2.subdir + commons.release.2.subdir + false + false + ${commons.release.2.subdir} + java.lang.String + Subdirectory (instead of source/binaries.) + + + commons.release.2.hash + commons.release.2.hash + false + false + ${commons.release.2.hash} + java.lang.String + Type of hash (lower case, e.g. sha512) + + + + commons.release.3.version + commons.release.3.version + false + false + ${commons.release.3.version} + java.lang.String + The version of an alternative release of the project. + + + commons.release.3.name + commons.release.3.name + true + false + ${commons.release.3.name} + java.lang.String + The name of the alternative release of the project. + + + commons.release.3.desc + commons.release.3.desc + false + false + ${commons.release.3.desc} + java.lang.String + Alternative Release Title or Description. + + + commons.release.3.binary.suffix + commons.release.3.binary.suffix + false + false + ${commons.release.3.binary.suffix} + java.lang.String + The suffix for the alternative release binary distribution. + + + commons.release.3.subdir + commons.release.3.subdir + false + false + ${commons.release.3.subdir} + java.lang.String + Subdirectory (instead of source/binaries.) + + + commons.release.3.hash + commons.release.3.hash + false + false + ${commons.release.3.hash} + java.lang.String + Type of hash (lower case, e.g. sha512) + + + + commons.release.4.version + commons.release.4.version + false + false + ${commons.release.4.version} + java.lang.String + The version of an alternative release of the project. + + + commons.release.4.name + commons.release.4.name + true + false + ${commons.release.4.name} + java.lang.String + The name of the alternative release of the project. + + + commons.release.4.desc + commons.release.4.desc + false + false + ${commons.release.4.desc} + java.lang.String + Alternative Release Title or Description. + + + commons.release.4.binary.suffix + commons.release.4.binary.suffix + false + false + ${commons.release.4.binary.suffix} + java.lang.String + The suffix for the alternative release binary distribution. + + + commons.release.4.subdir + commons.release.4.subdir + false + false + ${commons.release.4.subdir} + java.lang.String + Subdirectory (instead of source/binaries.) + + + commons.release.4.hash + commons.release.4.hash + false + false + ${commons.release.4.hash} + java.lang.String + Type of hash (lower case, e.g. sha512) + + + + + mail-page + mail-page + Apache Commons Build Mojo: Generate Mailing List page. + true + + + project.name + project.name + true + true + ${project.name} + java.lang.String + The name of the project currently being built. + + + commons.componentid + commons.componentid + true + true + ${commons.componentid} + java.lang.String + The commons component id. + + + + + jira-page + jira-page + Apache Commons Build Mojo: Generate Issue Tracking page. + true + + + project.name + project.name + true + true + ${project.name} + java.lang.String + The name of the project currently being built. + + + commons.jira.id + commons.jira.id + true + false + ${commons.jira.id} + java.lang.String + The external JIRA id for the project (alphabetic, upper case.) + + + commons.jira.pid + commons.jira.pid + true + false + ${commons.jira.pid} + java.lang.String + The internal JIRA id for the project (numeric.) + + + + + sandbox-jira-page + sandbox-jira-page + Apache Commons Build Mojo: Generate Sandbox Issue Tracking page. + true + + + project.name + project.name + true + true + ${project.name} + java.lang.String + The name of the project currently being built. + + + commons.jira.componentid + commons.jira.componentid + true + false + ${commons.jira.componentid} + java.lang.String + The internal JIRA component id (numeric.) + + + + + download-page + download-page + Apache Commons Build Mojo: Generate Download page. + true + + + project.name + project.name + true + true + ${project.name} + java.lang.String + The name of the project currently being built. + + + project.artifactId + project.artifactId + true + true + ${project.artifactId} + java.lang.String + The artifactId of the project currently being built. + + + commons.componentid + commons.componentid + true + true + ${commons.componentid} + java.lang.String + The commons component id. + + + commons.release.version + commons.release.version + true + false + ${commons.release.version} + java.lang.String + The version of the latest release of the project. + + + commons.release.name + commons.release.name + true + false + ${commons.release.name} + java.lang.String + The name of the latest release of the project. + + + commons.binary.suffix + commons.binary.suffix + false + false + ${commons.binary.suffix} + java.lang.String + The suffix for the binary distribution. + + + commons.release.desc + commons.release.desc + false + false + ${commons.release.desc} + java.lang.String + Release Title or Description. + + + commons.release.subdir + commons.release.subdir + false + false + ${commons.release.subdir} + java.lang.String + Subdirectory (instead of source/binaries.) + + + commons.release.hash + commons.release.hash + false + false + ${commons.release.hash} + java.lang.String + Type of hash (lower case, e.g. sha512) + + + + commons.release.2.version + commons.release.2.version + false + false + ${commons.release.2.version} + java.lang.String + The version of an alternative release of the project. + + + commons.release.2.name + commons.release.2.name + true + false + ${commons.release.2.name} + java.lang.String + The name of the alternative release of the project. + + + commons.release.2.desc + commons.release.2.desc + false + false + ${commons.release.2.desc} + java.lang.String + Alternative Release Title or Description. + + + commons.release.2.binary.suffix + commons.release.2.binary.suffix + false + false + ${commons.release.2.binary.suffix} + java.lang.String + The suffix for the alternative release binary distribution. + + + commons.release.2.subdir + commons.release.2.subdir + false + false + ${commons.release.2.subdir} + java.lang.String + Subdirectory (instead of source/binaries.) + + + commons.release.2.hash + commons.release.2.hash + false + false + ${commons.release.2.hash} + java.lang.String + Type of hash (lower case, e.g. sha512) + + + + commons.release.3.version + commons.release.3.version + false + false + ${commons.release.3.version} + java.lang.String + The version of an alternative release of the project. + + + commons.release.3.name + commons.release.3.name + true + false + ${commons.release.3.name} + java.lang.String + The name of the alternative release of the project. + + + commons.release.3.desc + commons.release.3.desc + false + false + ${commons.release.3.desc} + java.lang.String + Alternative Release Title or Description. + + + commons.release.3.binary.suffix + commons.release.3.binary.suffix + false + false + ${commons.release.3.binary.suffix} + java.lang.String + The suffix for the alternative release binary distribution. + + + commons.release.3.subdir + commons.release.3.subdir + false + false + ${commons.release.3.subdir} + java.lang.String + Subdirectory (instead of source/binaries.) + + + commons.release.3.hash + commons.release.3.hash + false + false + ${commons.release.3.hash} + java.lang.String + Type of hash (lower case, e.g. sha512) + + + + commons.release.4.version + commons.release.4.version + false + false + ${commons.release.4.version} + java.lang.String + The version of an alternative release of the project. + + + commons.release.4.name + commons.release.4.name + true + false + ${commons.release.4.name} + java.lang.String + The name of the alternative release of the project. + + + commons.release.4.desc + commons.release.4.desc + false + false + ${commons.release.4.desc} + java.lang.String + Alternative Release Title or Description. + + + commons.release.4.binary.suffix + commons.release.4.binary.suffix + false + false + ${commons.release.4.binary.suffix} + java.lang.String + The suffix for the alternative release binary distribution. + + + commons.release.4.subdir + commons.release.4.subdir + false + false + ${commons.release.4.subdir} + java.lang.String + Subdirectory (instead of source/binaries.) + + + commons.release.4.hash + commons.release.4.hash + false + false + ${commons.release.4.hash} + java.lang.String + Type of hash (lower case, e.g. sha512) + + + + + readme-md + readme-md + Apache Commons Build Mojo: Generate README.md. + true + + + project.name + project.name + true + true + ${project.name} + java.lang.String + The name of the project currently being built. + + + project.description + project.description + true + true + ${project.description} + java.lang.String + A description of the project currently being built. + + + project.artifactId + project.artifactId + true + true + ${project.artifactId} + java.lang.String + The artifactId of the project currently being built. + + + project.groupId + project.groupId + true + true + ${project.groupId} + java.lang.String + The groupId of the project currently being built. + + + commons.jira.id + commons.jira.id + true + false + ${commons.jira.id} + java.lang.String + The external JIRA id for the project (alphabetic, upper case.) + + + commons.release.version + commons.release.version + true + false + ${commons.release.version} + java.lang.String + The version of the latest release of the project. + + + commons.componentid + commons.componentid + true + true + ${commons.componentid} + java.lang.String + The commons component id. + + + + + notice-txt + notice-txt + Apache Commons Build Mojo: Generate NOTICE.txt. + true + + + project.name + project.name + true + true + ${project.name} + java.lang.String + The name of the project currently being built. + + + project.inceptionYear + project.inceptionYear + true + true + ${project.inceptionYear} + java.lang.String + The inception year of the project currently being built. + + + + + contributing-md + contributing-md + Apache Commons Build Mojo: Generate CONTRIBUTING.md. + true + + + project.name + project.name + true + true + ${project.name} + java.lang.String + The name of the project currently being built. + + + project.artifactId + project.artifactId + true + true + ${project.artifactId} + java.lang.String + The artifactId of the project currently being built. + + + commons.jira.id + commons.jira.id + true + false + ${commons.jira.id} + java.lang.String + The external JIRA id for the project (alphabetic, upper case.) + + + commons.componentid + commons.componentid + true + true + ${commons.componentid} + java.lang.String + The commons component id. + + + + + diff --git a/src/site/resources/profile.noanimal b/src/site/resources/profile.noanimal index e69de29bb..0314c63ff 100644 --- a/src/site/resources/profile.noanimal +++ b/src/site/resources/profile.noanimal @@ -0,0 +1,16 @@ +// 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 +// +// 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, 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. diff --git a/src/site/site.xml b/src/site/site.xml index 9c358bca8..b82bfaaf4 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -15,8 +15,10 @@ See the License for the specific language governing permissions and limitations under the License. --> - - + @@ -52,10 +54,9 @@ - - + + - - + diff --git a/src/site/xdoc/all-mojo.xml b/src/site/xdoc/all-mojo.xml index b9865a069..392990089 100644 --- a/src/site/xdoc/all-mojo.xml +++ b/src/site/xdoc/all-mojo.xml @@ -15,14 +15,16 @@ See the License for the specific language governing permissions and limitations under the License. --> - + commons-build:all

Full name:

-

org.apache.commons:commons-build-plugin:1.9:all

+

org.apache.commons:commons-build-plugin:1.11:all

Description:

Apache Commons Build Mojo: Generate all pages

Attributes:

diff --git a/src/site/xdoc/all-mojo-sandbox.xml b/src/site/xdoc/all-sandbox-mojo.xml similarity index 86% rename from src/site/xdoc/all-mojo-sandbox.xml rename to src/site/xdoc/all-sandbox-mojo.xml index 64c556329..5728f90a4 100644 --- a/src/site/xdoc/all-mojo-sandbox.xml +++ b/src/site/xdoc/all-sandbox-mojo.xml @@ -15,14 +15,16 @@ See the License for the specific language governing permissions and limitations under the License. --> - + commons-build:all

Full name:

-

org.apache.commons:commons-build-plugin:1.9:all-sandbox

+

org.apache.commons:commons-build-plugin:1.11:all-sandbox

Description:

Apache Commons Build Mojo: Generate all sandbox pages

Attributes:

diff --git a/src/site/xdoc/all-sandbox.xml b/src/site/xdoc/all-sandbox.xml index e9a6b282a..405acada8 100644 --- a/src/site/xdoc/all-sandbox.xml +++ b/src/site/xdoc/all-sandbox.xml @@ -15,8 +15,9 @@ See the License for the specific language governing permissions and limitations under the License. --> - - + Generating All Sandbox Pages Apache Commons Documentation Team @@ -25,7 +26,7 @@ -
+

@@ -35,14 +36,14 @@

This goal uses the following: +

-

diff --git a/src/site/xdoc/all.xml b/src/site/xdoc/all.xml index 7360a4d49..7a6da1542 100644 --- a/src/site/xdoc/all.xml +++ b/src/site/xdoc/all.xml @@ -15,8 +15,9 @@ See the License for the specific language governing permissions and limitations under the License. --> - - + Generating All Pages Apache Commons Documentation Team @@ -24,8 +25,7 @@ - -
+

@@ -35,14 +35,14 @@

This goal uses the following: +

-

diff --git a/src/site/xdoc/contributing-md-mojo.xml b/src/site/xdoc/contributing-md-mojo.xml index 477c5018b..9aae988b9 100644 --- a/src/site/xdoc/contributing-md-mojo.xml +++ b/src/site/xdoc/contributing-md-mojo.xml @@ -15,14 +15,15 @@ See the License for the specific language governing permissions and limitations under the License. --> - - + commons-build:contributing-md

Full name:

-

org.apache.commons:commons-build-plugin:1.9:contributing-md

+

org.apache.commons:commons-build-plugin:1.11:contributing-md

Description:

Apache Commons Build Mojo: Generate CONTRIBUTING.md

Attributes:

diff --git a/src/site/xdoc/contributing-md.xml b/src/site/xdoc/contributing-md.xml index aeabb0a3d..7ce782566 100644 --- a/src/site/xdoc/contributing-md.xml +++ b/src/site/xdoc/contributing-md.xml @@ -15,8 +15,9 @@ See the License for the specific language governing permissions and limitations under the License. --> - - + Generating CONTRIBUTING.md Apache Commons Documentation Team @@ -25,7 +26,7 @@ -
+

@@ -39,31 +40,31 @@

This goal uses the following: +

-

To generate a CONTRIBUTING.md, the following properties are configured in the component's pom.xml +

  • commons.jira.id - JIRA's external (upper case) project id for the component
-

- Example configuration for Commons Chain: + Example configuration for Commons Text:

diff --git a/src/site/xdoc/copy-javadoc-files-build.xml b/src/site/xdoc/copy-javadoc-files-build.xml index 88d0fa468..7794eb7c8 100644 --- a/src/site/xdoc/copy-javadoc-files-build.xml +++ b/src/site/xdoc/copy-javadoc-files-build.xml @@ -15,8 +15,9 @@ See the License for the specific language governing permissions and limitations under the License. --> - - + Copy NOTICE and LICENSE files to javadoc jar Apache Commons Documentation Team @@ -38,8 +39,8 @@ See:

diff --git a/src/site/xdoc/copy-javadoc-files-mojo.xml b/src/site/xdoc/copy-javadoc-files-mojo.xml index f4611ddf0..8f05d9155 100644 --- a/src/site/xdoc/copy-javadoc-files-mojo.xml +++ b/src/site/xdoc/copy-javadoc-files-mojo.xml @@ -15,14 +15,16 @@ See the License for the specific language governing permissions and limitations under the License. --> - + commons-build:copy-javadoc-files

Full name:

-

org.apache.commons:commons-build-plugin:1.9:copy-javadoc-files

+

org.apache.commons:commons-build-plugin:1.11:copy-javadoc-files

Description:

Commons Build: Copy NOTICE and LICENSE files to -javadoc.jar

Attributes:

diff --git a/src/site/xdoc/development.xml b/src/site/xdoc/development.xml index 147fa1397..2150d05c5 100644 --- a/src/site/xdoc/development.xml +++ b/src/site/xdoc/development.xml @@ -15,8 +15,9 @@ See the License for the specific language governing permissions and limitations under the License. --> - - + Development Apache Commons Documentation Team @@ -27,7 +28,7 @@

- The best sources of information are: + The best sources of information are:

  • Apache Maven Guide to using Ant with Maven
    • @@ -40,6 +41,7 @@

    Each ant script requires two files, which have to be named following the conventions for ant plugins: +

    • An ant build file
      • [naming convention: basename.build.xml]
      @@ -48,7 +50,6 @@
      • [naming convention: basename.mojos.xml]
    -

    So if you want to add a new foo-bar ant script you would create a foo-bar.build.xml @@ -57,19 +58,19 @@

    Both these files should be located in the - src/main/scripts + src/main/scripts directory.

    If you want to access variables from the component's pom.xml in the ant script then you need to do two things in the mapping document: +

    • Add the <requiresProject>true</requiresProject>
    • Add <parameter> elements for each of the variables you want to use.
    -

@@ -79,7 +80,7 @@ This plugin uses commons as the goal prefix. So if you add a new foo-bar goal, then it can be executed on the command line using mvn commons-build:foo-bar. This prefix is defined in this plugin's - pom.xml. + pom.xml.

@@ -87,7 +88,7 @@

- Not alot to say about this except, if you need access to additional variables from the component's + Not a lot to say about this except, if you need access to additional variables from the component's pom.xml in the ant build script then you will need to define additional parameters for these in the associated mapping document.

diff --git a/src/site/xdoc/download-page-mojo.xml b/src/site/xdoc/download-page-mojo.xml index 71b042bb7..2e6a8a4f2 100644 --- a/src/site/xdoc/download-page-mojo.xml +++ b/src/site/xdoc/download-page-mojo.xml @@ -15,16 +15,18 @@ See the License for the specific language governing permissions and limitations under the License. --> - + commons-build:download-page

Full name:

-

org.apache.commons:commons-build-plugin:1.9:download-page

+

org.apache.commons:commons-build-plugin:1.11:download-page

Description:

-
Apache Apache Commons Build Mojo: Generate Download page
+
Apache Commons Build Mojo: Generate Download page

Attributes:

  • Requires a Maven 2.0 project to be executed.
    • @@ -62,6 +64,12 @@ - The name of the alternative release of the project.
    Default value is: ${commons.release.3.name}. + + commons.release.4.name + String + - + The name of the alternative release of the project.
    Default value is: ${commons.release.4.name}. + basedir File @@ -206,8 +214,9 @@
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.release.desc}
    • -

commons.release.2.version:

+
+

commons.release.2.version:

The version of an alternative release of the project.
  • Type: java.lang.String
    • @@ -231,8 +240,9 @@
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.release.2.binary.suffix}
    • -

commons.release.3.version:

+
+

commons.release.3.version:

The version of an alternative release of the project.
  • Type: java.lang.String
    • @@ -259,24 +269,25 @@

basedir:

The base directory from which to execute the Ant script.
+

commons.release.4.version:

The version of an alternative release of the project.
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.release.4.version}
    • -

commons.release.4.name:

+

commons.release.4.name:

The name of the alternative release of the project.
  • Type: java.lang.String
  • Required: Yes
  • Default: ${commons.release.4.name}
    • -

commons.release.3.desc:

+

commons.release.4.desc:

Alternative Release Title or Description.
  • Type: java.lang.String
  • Required: No
  • Default: ${commons.release.4.desc}
    • -

commons.release.3.binary.suffix:

+

commons.release.4.binary.suffix:

The suffix for the alternative release binary distro.
  • Type: java.lang.String
    • diff --git a/src/site/xdoc/download-page.xml b/src/site/xdoc/download-page.xml index cd8ab9822..d28277403 100644 --- a/src/site/xdoc/download-page.xml +++ b/src/site/xdoc/download-page.xml @@ -15,8 +15,9 @@ See the License for the specific language governing permissions and limitations under the License. --> - - + Generating Download Page Apache Commons Documentation Team @@ -24,8 +25,7 @@ - -
    +

    @@ -35,37 +35,38 @@

    The above command generates an xdoc page named download_componentid.xml in either the xdocs - or src/site/xdoc directory (depending on which exists), which should be checked into subversion. + or src/site/xdoc directory (depending on which exists), which should be checked into git. This will cause a download_componentid.html page to be generated when the mvn site is run. Remember to add a Download link to download_componentid.cgi to the maven site.xml.

    - Note: The Download page should only need to be re-generated after a new release of the component + Note: The Download page should only need to be re-generated after a new release of the component or if the download page template changes.

    This goal uses the following: +

    -

    To generate a Download page, the following properties are configured in the component's pom.xml +

    • commons.componentid - Commons component id
    • commons.release.version - The version number of the latest release of the component
      • @@ -75,50 +76,49 @@ (some components use "-bin", others have no suffix)
    • commons.release.subdir - The subdirectory to use. This defaults to using separate source/binaries folders; it set it will be used as the directory for both.
    -

    - Example configuration for Commons Chain: + Example configuration for Commons Text:

    Sometimes there is a requirement to list two versions on the download page. This can be achieved using the following properties: +

    • commons.release.2.version - The version number of the alternative release of the component
    • commons.release.2.name - (optional - defaults to ${commons.release.2.name}) The name of the alternative release of the component
    • commons.release.2.desc - (optional) Additional text to append to the section name of the alternative release
      • -
    • commons.release.2.binary.suffix - (optional - defaults to -bin) The suffix for the alternative +
    • commons.release.2.binary.suffix - (optional - defaults to -bin) The suffix for the alternative binary release (some components use "-bin", others have no suffix)
    • commons.release.2.subdir - The subdirectory to use. This defaults to using separate source/binaries folders; it set it will be used as the directory for both.
    -

    You can have a third version on the download page. This can be achieved using the following properties: +

    • commons.release.3.version - The version number of the alternative release of the component
    • commons.release.3.name - (optional - defaults to ${commons.release.3.name}) The name of the alternative release of the component
    • commons.release.3.desc - (optional) Additional text to append to the section name of the alternative release
      • -
    • commons.release.3.binary.suffix - (optional - defaults to -bin) The suffix for the alternative +
    • commons.release.3.binary.suffix - (optional - defaults to -bin) The suffix for the alternative binary release (some components use "-bin", others have no suffix)
    • commons.release.3.subdir - The subdirectory to use. This defaults to using separate source/binaries folders; it set it will be used as the directory for both.
    -

    You can have a fourth version on the download page. This can be achieved using the following properties: +

    • commons.release.4.version - The version number of the alternative release of the component
    • commons.release.4.name - (optional - defaults to ${commons.release.4.name}) The name of the alternative release of the component
    • commons.release.4.desc - (optional) Additional text to append to the section name of the alternative release
      • -
    • commons.release.4.binary.suffix - (optional - defaults to -bin) The suffix for the alternative +
    • commons.release.4.binary.suffix - (optional - defaults to -bin) The suffix for the alternative binary release (some components use "-bin", others have no suffix)
    • commons.release.4.subdir - The subdirectory to use. This defaults to using separate source/binaries folders; it set it will be used as the directory for both.
    -

    Example configuration for Commons DBCP with two releases:

    diff --git a/src/site/xdoc/download_commons-build-plugin.xml b/src/site/xdoc/download_build-plugin.xml similarity index 62% rename from src/site/xdoc/download_commons-build-plugin.xml rename to src/site/xdoc/download_build-plugin.xml index 9d0e16598..460fbfeac 100644 --- a/src/site/xdoc/download_commons-build-plugin.xml +++ b/src/site/xdoc/download_build-plugin.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, @@ -29,19 +29,21 @@ limitations under the License. | 1) Re-generate using: mvn commons-build:download-page | | | | 2) Set the following properties in the component's pom: | - | - commons.componentid (required, alphabetic, lower case) | + | - commons.componentid (required, alphabetic, lower case) | | - commons.release.version (required) | | - commons.release.name (required) | | - commons.binary.suffix (optional) | | (defaults to "-bin", set to "" for pre-maven2 releases) | | - commons.release.desc (optional) | | - commons.release.subdir (optional) | + | - commons.release.hash (optional, lowercase, default sha512) | | | - | - commons.release.2/3.version (conditional) | - | - commons.release.2/3.name (conditional) | - | - commons.release.2/3.binary.suffix (optional) | - | - commons.release.2/3.desc (optional) | - | - commons.release.2/3.subdir (optional) | + | - commons.release.[234].version (conditional) | + | - commons.release.[234].name (conditional) | + | - commons.release.[234].binary.suffix (optional) | + | - commons.release.[234].desc (optional) | + | - commons.release.[234].subdir (optional) | + | - commons.release.[234].hash (optional, lowercase, [sha512])| | | | 3) Example Properties | | (commons.release.name inherited by parent: | @@ -54,17 +56,19 @@ limitations under the License. | | +======================================================================+ --> - + Download Apache Commons Build Plugin Maven Mojo - Apache Commons Documentation Team + Apache Commons Team

    We recommend you use a mirror to download our release - builds, but you must verify the integrity of + builds, but you must verify the integrity of the downloaded files using signatures downloaded from our main distribution directories. Recent releases (48 hours) may not yet be available from all the mirrors. @@ -77,7 +81,7 @@ limitations under the License. mirrors (at the end of the mirrors list) that should be available.

    - [if-any logo][end] + [if-any logo]Logo[end]

    @@ -102,41 +106,41 @@ limitations under the License. It is essential that you verify the integrity of downloaded files, preferably using the PGP signature (*.asc files); - failing that using the SHA1 hash (*.sha1 checksum files). + failing that using the SHA512 hash (*.sha512 checksum files).

    - The KEYS + The KEYS file contains the public PGP keys used by Apache Commons developers to sign releases.

    -
    +
    - - - + + + - - - + + +
    commons-build-plugin-1.9-SNAPSHOT-bin.tar.gzsha1pgpcommons-build-plugin-1.15.0-bin.tar.gzsha512pgp
    commons-build-plugin-1.9-SNAPSHOT-bin.zipsha1pgpcommons-build-plugin-1.15.0-bin.zipsha512pgp
    - - - + + + - - - + + +
    commons-build-plugin-1.9-SNAPSHOT-src.tar.gzsha1pgpcommons-build-plugin-1.15.0-src.tar.gzsha512pgp
    commons-build-plugin-1.9-SNAPSHOT-src.zipsha1pgpcommons-build-plugin-1.15.0-src.zipsha512pgp
    @@ -146,8 +150,8 @@ limitations under the License. Older releases can be obtained from the archives.

    diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml index bae177379..dd1c3e2f8 100644 --- a/src/site/xdoc/index.xml +++ b/src/site/xdoc/index.xml @@ -15,8 +15,9 @@ See the License for the specific language governing permissions and limitations under the License. --> - - + Overview Apache Commons Documentation Team @@ -27,18 +28,19 @@

    - This is a Maven 2.x/3.x - Ant Plugin which is - used by Apache Commons builds. See + This is a Maven 2.x/3.x + Ant Plugin which is + used by Apache Commons builds. See the Development page for information to help maintain this plugin.

    -
    +

    Available Goals: +

    -

    @@ -60,7 +61,7 @@ org.apache.commons commons-build-plugin - 1.9 + 1.13 ]]>

    @@ -72,7 +73,7 @@

    As noted above, you can override POM properties if necessary.

    To use a SNAPSHOT version (for testing etc)

    - mvn org.apache.commons:commons-build-plugin:1.10-SNAPSHOT:download-page [-Dcommons.release.version=1.2.3] + mvn org.apache.commons:commons-build-plugin:1.14.0-SNAPSHOT:download-page [-Dcommons.release.version=1.2.3]
    diff --git a/src/site/xdoc/issue-tracking.xml b/src/site/xdoc/issue-tracking.xml index f2d89dfd8..a9bbfb6f7 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. | | +======================================================================+ --> - + Apache Commons Build Plugin Maven Mojo Issue tracking - Apache Commons Documentation Team + Apache Commons Team @@ -64,6 +66,7 @@ limitations under the License.

    If you would like to report a bug, or raise an enhancement request with Apache Commons Build Plugin Maven Mojo please do the following: +

    1. Search existing open bugs. If you find your issue listed then please add a comment with your details.
      2. @@ -73,30 +76,29 @@ limitations under the License.
    2. Submit either a bug report or enhancement request.
    -

    Please also remember these points: +

    • the more information you provide, the better we can help you
    • test cases are vital, particularly for any proposed enhancements
    • the developers of Apache Commons Build Plugin Maven Mojo are all unpaid volunteers
    -

    - For more information on subversion and creating patches see the - Apache Contributors Guide. + For more information on creating patches see the + Apache Contributors Guide.

    You may also find these links useful: +

    -

    diff --git a/src/site/xdoc/jira-page-mojo.xml b/src/site/xdoc/jira-page-mojo.xml index 007e9ed48..087f03aa7 100644 --- a/src/site/xdoc/jira-page-mojo.xml +++ b/src/site/xdoc/jira-page-mojo.xml @@ -15,14 +15,16 @@ See the License for the specific language governing permissions and limitations under the License. --> - + commons-build:jira-page

    Full name:

    -

    org.apache.commons:commons-build-plugin:1.9:jira-page

    +

    org.apache.commons:commons-build-plugin:1.11:jira-page

    Description:

    Apache Commons Build Mojo: Generate Issue Tracking page

    Attributes:

    diff --git a/src/site/xdoc/jira-page.xml b/src/site/xdoc/jira-page.xml index b108d3b43..bb958115f 100644 --- a/src/site/xdoc/jira-page.xml +++ b/src/site/xdoc/jira-page.xml @@ -15,9 +15,9 @@ See the License for the specific language governing permissions and limitations under the License. --> - - - + Generating JIRA Page Apache Commons Documentation Team @@ -25,7 +25,7 @@ -
    +

    @@ -41,34 +41,34 @@

    This goal uses the following: +

    -

    To generate a JIRA page, the following properties are configured in the component's pom.xml +

    • commons.jira.id - JIRA's external (upper case) project id for the component
    • commons.jira.pid - JIRA's internal (numeric) project id for the component
    -

    - Example configuration for Commons Chain: + Example configuration for Commons Text:

    diff --git a/src/site/xdoc/mail-lists.xml b/src/site/xdoc/mail-lists.xml index aff8387f1..01fc11745 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,29 +39,31 @@ limitations under the License. | | +======================================================================+ --> - + Apache Commons Build Plugin Maven Mojo Mailing Lists - Apache Commons Documentation Team + Apache Commons Team

    Apache Commons Build Plugin Maven Mojo shares mailing lists with all the other - Commons Components. + Commons Components. 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: -

      -
    • [commons-build-plugin] Problem with the ...
      • -

    +
      +
    • [build-plugin] Problem with the ...
      • +

    Questions related to the usage of Apache Commons Build Plugin Maven Mojo should be posted to the - User List. + User List.
    - The Developer List + The Developer List is for questions and discussion related to the development of Apache Commons Build Plugin Maven Mojo.
    Please do not cross-post; developers are also subscribed to the user list. @@ -70,8 +72,10 @@ limitations under the License. to subscribe.

    - Note: please don't send patches or attachments to any of the mailing lists. + Note: please don't send patches or attachments to any of the mailing lists; + most of the lists are set up to drop attachments. Patches are best handled via the Issue Tracking system. + If you have a GitHub account, most components also accept PRs (pull requests). Otherwise, please upload the file to a public server and include the URL in the mail.

    @@ -79,7 +83,7 @@ limitations under the License.

    Please prefix the subject line of any messages for Apache Commons Build Plugin Maven Mojo - with [commons-build-plugin] - thanks! + with [build-plugin] - thanks!

    @@ -104,11 +108,12 @@ limitations under the License. Subscribe Unsubscribe - Post - mail-archives.apache.org - markmail.org
    - www.mail-archive.com
    - news.gmane.org + Post + + lists.apache.org + + + www.mail-archive.com @@ -122,11 +127,12 @@ limitations under the License. Subscribe Unsubscribe - Post - mail-archives.apache.org - markmail.org
    - www.mail-archive.com
    - news.gmane.org + Post + + lists.apache.org + + + www.mail-archive.com @@ -141,9 +147,11 @@ limitations under the License. Subscribe Unsubscribe read only - mail-archives.apache.org - markmail.org
    - www.mail-archive.com + + lists.apache.org + + + www.mail-archive.com @@ -152,15 +160,17 @@ limitations under the License. Commons Commits List

    - Only for e-mails automatically generated by the source control sytem. + Only for e-mails automatically generated by the source control system.

    Subscribe Unsubscribe read only - mail-archives.apache.org - markmail.org
    - www.mail-archive.com + + lists.apache.org + + + www.mail-archive.com @@ -191,11 +201,11 @@ limitations under the License. Subscribe Unsubscribe read only - mail-archives.apache.org - markmail.org
    - old.nabble.com
    - www.mail-archive.com
    - news.gmane.org + + lists.apache.org + + + www.mail-archive.com diff --git a/src/site/xdoc/mail-page-mojo.xml b/src/site/xdoc/mail-page-mojo.xml index 95a7edf65..0429f5c62 100644 --- a/src/site/xdoc/mail-page-mojo.xml +++ b/src/site/xdoc/mail-page-mojo.xml @@ -15,14 +15,16 @@ See the License for the specific language governing permissions and limitations under the License. --> - + commons-build:mail-page

    Full name:

    -

    org.apache.commons:commons-build-plugin:1.9:mail-page

    +

    org.apache.commons:commons-build-plugin:1.11:mail-page

    Description:

    Apache Commons Build Mojo: Generate Mailing List page

    Attributes:

    diff --git a/src/site/xdoc/mail-page.xml b/src/site/xdoc/mail-page.xml index db1aacb3d..6de1e1f51 100644 --- a/src/site/xdoc/mail-page.xml +++ b/src/site/xdoc/mail-page.xml @@ -15,8 +15,9 @@ See the License for the specific language governing permissions and limitations under the License. --> - - + Generating Mailing List Page Apache Commons Documentation Team @@ -25,7 +26,7 @@ -
    +

    @@ -40,32 +41,32 @@

    This goal uses the following: +

    -

    To generate a Mailing List page, the following properties are configured in the component's pom.xml +

    • commons.componentid - Commons component id
    -

    - Example configuration for Commons Chain: + Example configuration for Commons Text:

    diff --git a/src/site/xdoc/notice-txt-mojo.xml b/src/site/xdoc/notice-txt-mojo.xml index 71ac87992..e1a904d5e 100644 --- a/src/site/xdoc/notice-txt-mojo.xml +++ b/src/site/xdoc/notice-txt-mojo.xml @@ -15,14 +15,16 @@ See the License for the specific language governing permissions and limitations under the License. --> - + commons-build:notice-txt

    Full name:

    -

    org.apache.commons:commons-build-plugin:1.9:notice-txt

    +

    org.apache.commons:commons-build-plugin:1.11:notice-txt

    Description:

    Apache Commons Build Mojo: Generate NOTICE.txt

    Attributes:

    diff --git a/src/site/xdoc/notice-txt.xml b/src/site/xdoc/notice-txt.xml index 70ef4cab6..e0f46078d 100644 --- a/src/site/xdoc/notice-txt.xml +++ b/src/site/xdoc/notice-txt.xml @@ -15,8 +15,9 @@ See the License for the specific language governing permissions and limitations under the License. --> - - + Generating NOTICE.txt Apache Commons Documentation Team @@ -25,7 +26,7 @@ -
    +

    @@ -40,32 +41,32 @@

    This goal uses the following: +

    -

    To generate a README.md, the following properties are configured in the component's pom.xml +

    • project.inceptionYear - The year of the project's inception, specified with 4 digits. This value is used when generating copyright notices as well as being informational.
    -

    - Example configuration for Commons Chain: + Example configuration for Commons Text:

    diff --git a/src/site/xdoc/readme-md-mojo.xml b/src/site/xdoc/readme-md-mojo.xml index 0774dfaec..c176e5642 100644 --- a/src/site/xdoc/readme-md-mojo.xml +++ b/src/site/xdoc/readme-md-mojo.xml @@ -15,14 +15,16 @@ See the License for the specific language governing permissions and limitations under the License. --> - + commons-build:readme-md

    Full name:

    -

    org.apache.commons:commons-build-plugin:1.9:readme-md

    +

    org.apache.commons:commons-build-plugin:1.11:readme-md

    Description:

    Apache Commons Build Mojo: Generate README.md

    Attributes:

    diff --git a/src/site/xdoc/readme-md.xml b/src/site/xdoc/readme-md.xml index ea701e6ab..2eecd8998 100644 --- a/src/site/xdoc/readme-md.xml +++ b/src/site/xdoc/readme-md.xml @@ -15,8 +15,9 @@ See the License for the specific language governing permissions and limitations under the License. --> - - + Generating README.md Apache Commons Documentation Team @@ -25,7 +26,7 @@ -
    +

    @@ -40,35 +41,35 @@

    This goal uses the following: +

    -

    To generate a README.md, the following properties are configured in the component's pom.xml +

    • commons.componentid - Commons component ID
    • commons.jira.id - Commons JIRA ID
    • commons.release.version - The version number of the latest release of the component
    -

    - Example configuration for Commons Chain: + Example configuration for Commons Text:

    diff --git a/src/site/xdoc/sandbox-jira-page-mojo.xml b/src/site/xdoc/sandbox-jira-page-mojo.xml index e47610dca..043da6cdc 100644 --- a/src/site/xdoc/sandbox-jira-page-mojo.xml +++ b/src/site/xdoc/sandbox-jira-page-mojo.xml @@ -15,14 +15,16 @@ See the License for the specific language governing permissions and limitations under the License. --> - + commons-build:sandbox-jira-page

    Full name:

    -

    org.apache.commons:commons-build-plugin:1.9:sandbox-jira-page

    +

    org.apache.commons:commons-build-plugin:1.11:sandbox-jira-page

    Description:

    Apache Commons Build Mojo: Generate Sandbox Issue Tracking page

    Attributes:

    diff --git a/src/site/xdoc/sandbox-jira-page.xml b/src/site/xdoc/sandbox-jira-page.xml index a9b456221..95f924353 100644 --- a/src/site/xdoc/sandbox-jira-page.xml +++ b/src/site/xdoc/sandbox-jira-page.xml @@ -15,8 +15,9 @@ See the License for the specific language governing permissions and limitations under the License. --> - - + Generating Sandbox JIRA Page Apache Commons Documentation Team @@ -24,8 +25,7 @@ - -
    +

    @@ -41,32 +41,32 @@

    This goal uses the following: +

    -

    To generate a JIRA page, the following properties are configured in the component's pom.xml +

    • commons.jira.componentid - JIRA's internal (numeric) id for the component
    -

    Example configuration:

    diff --git a/src/test-project/pom.xml b/src/test-project/pom.xml index a02076fcb..79ef78b93 100644 --- a/src/test-project/pom.xml +++ b/src/test-project/pom.xml @@ -15,7 +15,7 @@ See the License for the specific language governing permissions and limitations under the License. --> - + 4.0.0 org.apache.commons test-project @@ -25,11 +25,11 @@ Commons Build Plugin Test Project. - http://commons.apache.org/commons-build-plugin/ + https://commons.apache.org/commons-build-plugin/ jira - http://issues.apache.org/jira/browse/COMMONSSITE + https://issues.apache.org/jira/browse/COMMONSSITE