This is an automated email from the ASF dual-hosted git repository.
aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-numbers.git
commit 8f587293a64d18477879cee03029148a3eb455d3
Author: aherbert <aherb...@apache.org>
AuthorDate: Fri Oct 14 17:03:38 2022 +0100
NUMBERS-190: Add a Bill of Materials module
Add a new module based on commons-rng-bom.
Configured maven-assembly-plugin skipAssembly in the parent pom as it
should only be configured in the dist-archive module. This allows the
snapshot BOM to be deployed to the snapshots repo using:
mvn deploy -Dgpg.skip
Deploy of the non-snapshot BOM will target the Apache release staging
repository and must be GPG signed.
---
commons-numbers-bom/LICENSE | 201 +++++++++++++
commons-numbers-bom/NOTICE | 5 +
commons-numbers-bom/README.md | 88 ++++++
commons-numbers-bom/pom.xml | 328 +++++++++++++++++++++
.../src/main/resources-filtered/bom.xml | 91 ++++++
.../src/site/resources/style/module.css | 19 ++
{src => commons-numbers-bom/src}/site/site.xml | 25 +-
commons-numbers-bom/src/site/xdoc/index.xml | 75 +++++
doc/release/release.howto.txt | 18 +-
pom.xml | 18 +-
src/changes/changes.xml | 7 +-
src/site/site.xml | 3 +-
12 files changed, 843 insertions(+), 35 deletions(-)
diff --git a/commons-numbers-bom/LICENSE b/commons-numbers-bom/LICENSE
new file mode 100644
index 00000000..261eeb9e
--- /dev/null
+++ b/commons-numbers-bom/LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed 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.
diff --git a/commons-numbers-bom/NOTICE b/commons-numbers-bom/NOTICE
new file mode 100644
index 00000000..96cf7a70
--- /dev/null
+++ b/commons-numbers-bom/NOTICE
@@ -0,0 +1,5 @@
+Apache Commons Numbers
+Copyright 2001-2022 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
diff --git a/commons-numbers-bom/README.md b/commons-numbers-bom/README.md
new file mode 100644
index 00000000..448dc185
--- /dev/null
+++ b/commons-numbers-bom/README.md
@@ -0,0 +1,88 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<!---
+ +======================================================================+
+ |**** ****|
+ |**** This file is ADAPTED from the README generated by the ****|
+ |**** commons build plugin and must be edited ****|
+ |**** ****|
+ +======================================================================+
+--->
+Apache Commons Numbers (Bill of Materials)
+===================
+
+This Bill of Materials POM can be used to ease dependency management when
referencing multiple Apache Commons Numbers artifacts.
+
+Documentation
+-------------
+
+More information can be found on the [Apache Commons Numbers
homepage](https://commons.apache.org/proper/commons-numbers).
+Questions related to the usage of Apache Commons Numbers Sampling should be
posted to the [user mailing list][ml].
+
+Where can I get the latest release?
+-----------------------------------
+You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-numbers/download_numbers.cgi).
+
+Alternatively you can pull it from the central Maven repositories and use
+the Bill of Materials (BOM) for dependency management:
+
+```xml
+<dependencyManagement>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-numbers-bom</artifactId>
+ <version>1.1</version>
+ <type>pom</type>
+ <scope>import</scope>
+ </dependency>
+ </dependencies>
+</dependencyManagement>
+```
+
+Contributing
+------------
+
+We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+There are some guidelines which will make applying PRs easier for us:
++ No tabs! Please use spaces for indentation.
++ Respect the code style.
++ Create minimal diffs - disable on save actions like reformat source code or
organize imports. If you feel the source code should be reformatted create a
separate PR for this change.
++ Provide JUnit tests for your changes and make sure your changes don't break
any existing tests by running ```mvn```.
+
+If you plan to contribute on a regular basis, please consider filing a
[contributor license agreement](https://www.apache.org/licenses/#clas).
+You can learn more about contributing via GitHub in our [contribution
guidelines](CONTRIBUTING.md).
+
+License
+-------
+This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+
+See the `NOTICE` file for required notices and attributions.
+
+Donations
+---------
+You like Apache Commons Numbers? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+
+Additional Resources
+--------------------
+
++ [Apache Commons Homepage](https://commons.apache.org/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
++ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
++ `#apache-commons` IRC channel on `irc.freenode.org`
+
+[ml]:https://commons.apache.org/mail-lists.html
diff --git a/commons-numbers-bom/pom.xml b/commons-numbers-bom/pom.xml
new file mode 100644
index 00000000..60e64cd9
--- /dev/null
+++ b/commons-numbers-bom/pom.xml
@@ -0,0 +1,328 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ 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 xmlns="http://maven.apache.org/POM/4.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/maven-v4_0_0.xsd";>
+ <modelVersion>4.0.0</modelVersion>
+
+ <parent>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-numbers-parent</artifactId>
+ <version>1.1-SNAPSHOT</version>
+ </parent>
+
+ <artifactId>commons-numbers-bom</artifactId>
+ <version>1.1-SNAPSHOT</version>
+ <name>Apache Commons Numbers (Bill of Materials)</name>
+ <packaging>pom</packaging>
+
+ <description>Bill of Materials (BOM) to aid in dependency management when
referencing multiple Apache Commons Numbers artifacts.</description>
+
+ <!--
+ Note: This project pom is not the deployed BOM artifact.
+
+ This module inherits from commons-numbers-parent to obtain the Commons
build configuration.
+ However this pom is not actually installed or deployed. The project is
configured to
+ deploy a single artifact that is a Bill of Materials (BOM) for Commons
Numbers.
+
+ The BOM is a template in the project resources that is populated using the
properties
+ from this project pom using resource filtering. The BOM
dependencyManagement section is
+ manually added to the template and the version is collected from the
current project version.
+
+ This has been done to ensure a simplified BOM is deployed. Any pom
extending either
+ apache parent or commons-parent will include the dependencyManagement
section from
+ those poms. Any pom not extending commons-parent would require a
distributionManagement
+ section and profile to support the test-deploy functionality. This project
pom is
+ constructed to work in the Commons release process to install/deploy the
BOM artifact.
+ -->
+
+ <properties>
+ <!-- Workaround to avoid duplicating config files. -->
+ <numbers.parent.dir>${basedir}/..</numbers.parent.dir>
+
+ <!-- Skip the standard install and deploy to avoid processing this pom as
the artifact. -->
+ <maven.install.skip>true</maven.install.skip>
+ <maven.deploy.skip>true</maven.deploy.skip>
+
+ <!-- Disable unused plugins -->
+ <animal.sniffer.skip>true</animal.sniffer.skip>
+ <pmd.skip>true</pmd.skip>
+ <spotbugs.skip>true</spotbugs.skip>
+ <checkstyle.skip>true</checkstyle.skip>
+ <changes.jira.skip>true</changes.jira.skip>
+ <skipSurefireReport>true</skipSurefireReport>
+
+ <!-- Generated BOM. This is the artifact that is installed/deployed. -->
+ <numbers.bom.file>target/bom.xml</numbers.bom.file>
+ <!-- Repositories for the deploy:deploy-file goal.
+ These properties are duplicates of the parent distributionManagement.
+ The choice of which to use is based on the SNAPSHOT suffix. -->
+
<numbers.bom.snapshots.repositoryId>apache.snapshots.https</numbers.bom.snapshots.repositoryId>
+
<numbers.bom.snapshots.url>https://repository.apache.org/content/repositories/snapshots</numbers.bom.snapshots.url>
+
<numbers.bom.releases.repositoryId>apache.releases.https</numbers.bom.releases.repositoryId>
+
<numbers.bom.releases.url>https://repository.apache.org/service/local/staging/deploy/maven2</numbers.bom.releases.url>
+ </properties>
+
+ <build>
+ <plugins>
+ <plugin>
+ <!-- This plugin has no skip property - use an invalid phase -->
+ <groupId>org.spdx</groupId>
+ <artifactId>spdx-maven-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>build-spdx</id>
+ <goals>
+ <goal>createSPDX</goal>
+ </goals>
+ <phase>None</phase>
+ </execution>
+ </executions>
+ </plugin>
+ <plugin>
+ <!-- Generate the BOM from the template resource. This uses filtering
to
+ copy the correct properties from this project including version. -->
+ <artifactId>maven-resources-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>generate-bom</id>
+ <goals>
+ <goal>copy-resources</goal>
+ </goals>
+ <phase>process-resources</phase>
+ <configuration>
+ <resources>
+ <resource>
+ <directory>src/main/resources-filtered</directory>
+ <filtering>true</filtering>
+ </resource>
+ </resources>
+ <outputDirectory>${project.build.directory}</outputDirectory>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ <plugin>
+ <!--
+ Configure the destination repository based on the SNAPSHOT prefix.
+ This first sets tmp properties conditionally to snapshot, and then
+ updates them in the next phase to release if they are not snapshot.
+ Note: The input property value is unchanged if the regex does not
match.
+
+ m/SNAPSHOT/ m/$version/
+ Case 1: 1.5-SNAPSHOT -> snapshots -> snapshots
+ Case 2: 1.5 -> 1.5 -> releases
+ -->
+ <groupId>org.codehaus.mojo</groupId>
+ <artifactId>build-helper-maven-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>detect-snapshot</id>
+ <goals>
+ <goal>regex-properties</goal>
+ </goals>
+ <phase>validate</phase>
+ <configuration>
+ <regexPropertySettings>
+ <regexPropertySetting>
+ <name>bom.repositoryId.tmp</name>
+ <value>${project.version}</value>
+ <regex>.*-SNAPSHOT.*</regex>
+
<replacement>${numbers.bom.snapshots.repositoryId}</replacement>
+ <failIfNoMatch>false</failIfNoMatch>
+ </regexPropertySetting>
+ <regexPropertySetting>
+ <name>bom.url.tmp</name>
+ <value>${project.version}</value>
+ <regex>.*-SNAPSHOT.*</regex>
+ <replacement>${numbers.bom.snapshots.url}</replacement>
+ <failIfNoMatch>false</failIfNoMatch>
+ </regexPropertySetting>
+ </regexPropertySettings>
+ </configuration>
+ </execution>
+ <execution>
+ <id>detect-release</id>
+ <goals>
+ <goal>regex-properties</goal>
+ </goals>
+ <phase>initialize</phase>
+ <configuration>
+ <regexPropertySettings>
+ <regexPropertySetting>
+ <name>bom.repositoryId</name>
+ <value>${bom.repositoryId.tmp}</value>
+ <regex>${project.version}</regex>
+
<replacement>${numbers.bom.releases.repositoryId}</replacement>
+ <failIfNoMatch>false</failIfNoMatch>
+ </regexPropertySetting>
+ <regexPropertySetting>
+ <name>bom.url</name>
+ <value>${bom.url.tmp}</value>
+ <regex>${project.version}</regex>
+ <replacement>${numbers.bom.releases.url}</replacement>
+ <failIfNoMatch>false</failIfNoMatch>
+ </regexPropertySetting>
+ </regexPropertySettings>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ <!-- The install and deploy plugin goals are skipped.
+ Here we install the generated BOM file as the project artifact.
+ The deploy is performed by different plugins configured in profiles
+ depending if GPG signing is required. -->
+ <plugin>
+ <artifactId>maven-install-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>install-bom</id>
+ <goals>
+ <goal>install-file</goal>
+ </goals>
+ <phase>install</phase>
+ <configuration>
+ <file>${numbers.bom.file}</file>
+ <!-- Collect group, artifact, version and packaging from the BOM
-->
+ <pomFile>${numbers.bom.file}</pomFile>
+ <generatePom>false</generatePom>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+
+ <profiles>
+ <profile>
+ <!-- Match the test-deploy profile in commons-parent and deploy locally
-->
+ <id>test-deploy</id>
+ <properties>
+
<numbers.bom.snapshots.repositoryId>test-deploy</numbers.bom.snapshots.repositoryId>
+
<numbers.bom.releases.repositoryId>test-deploy</numbers.bom.releases.repositoryId>
+
<numbers.bom.snapshots.url>file:target/deploy</numbers.bom.snapshots.url>
+ <numbers.bom.releases.url>file:target/deploy</numbers.bom.releases.url>
+ </properties>
+ </profile>
+
+ <profile>
+ <!-- Changes to the commons-parent release profile -->
+ <id>release</id>
+ <build>
+ <plugins>
+ <plugin>
+ <artifactId>maven-gpg-plugin</artifactId>
+ <executions>
+ <!-- Skip the signing of the project artifact performed by
commons-parent
+ (i.e. the pom) to avoid generating additional .asc files in
the target
+ directory. These are mistakenly deployed in addition to the
desired asc
+ file from signing the genreated BOM. -->
+ <execution>
+ <id>sign-artifacts</id>
+ <goals>
+ <goal>sign</goal>
+ </goals>
+ <configuration>
+ <skip>true</skip>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+
+ <!-- Activate the appropriate deploy goal.
+ If both profiles are activated (using the profile ids) then this will
deploy the same
+ artifact twice with different build timestamps; only one is present
in the metadata.
+ The GPG signature is valid for either as it has no build timestamp.
-->
+ <profile>
+ <!-- deploy -->
+ <id>release-deploy</id>
+ <activation>
+ <property>
+ <name>gpg.skip</name>
+ <!-- This ignores the value for simplicity to allow -Dgpg.skip to
activate.
+ The side-effect being that -Dgpg.skip=false will still activate
the profile.
+ This is only relevant for the deploy phase and impacts the
release process. -->
+ </property>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <artifactId>maven-deploy-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>deploy-bom</id>
+ <goals>
+ <goal>deploy-file</goal>
+ </goals>
+ <phase>deploy</phase>
+ <configuration>
+ <!-- Dynamically configured destination based on SNAPSHOT or
test-deploy profile -->
+ <url>${bom.url}</url>
+ <repositoryId>${bom.repositoryId}</repositoryId>
+ <file>${numbers.bom.file}</file>
+ <!-- Collect group, artifact, version and packaging from the
BOM -->
+ <pomFile>${numbers.bom.file}</pomFile>
+ <generatePom>false</generatePom>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+
+ <profile>
+ <!-- sign and deploy -->
+ <id>release-sign-and-deploy</id>
+ <activation>
+ <property>
+ <!-- Opposite of the deploy profile -->
+ <name>!gpg.skip</name>
+ </property>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <artifactId>maven-gpg-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>deploy-bom</id>
+ <goals>
+ <goal>sign-and-deploy-file</goal>
+ </goals>
+ <phase>deploy</phase>
+ <configuration>
+ <!-- Dynamically configured destination based on SNAPSHOT or
test-deploy profile -->
+ <url>${bom.url}</url>
+ <repositoryId>${bom.repositoryId}</repositoryId>
+ <file>${numbers.bom.file}</file>
+ <!-- Collect group, artifact, version and packaging from the
BOM -->
+ <pomFile>${numbers.bom.file}</pomFile>
+ <generatePom>false</generatePom>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+
+ </profiles>
+
+</project>
diff --git a/commons-numbers-bom/src/main/resources-filtered/bom.xml
b/commons-numbers-bom/src/main/resources-filtered/bom.xml
new file mode 100644
index 00000000..43c1adfd
--- /dev/null
+++ b/commons-numbers-bom/src/main/resources-filtered/bom.xml
@@ -0,0 +1,91 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ 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
+ xmlns="http://maven.apache.org/POM/4.0.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/maven-v4_0_0.xsd";>
+ <modelVersion>4.0.0</modelVersion>
+
+ <groupId>${project.groupId}</groupId>
+ <artifactId>${project.artifactId}</artifactId>
+ <version>${project.version}</version>
+ <packaging>pom</packaging>
+ <name>${project.name}</name>
+ <description>${project.description}</description>
+ <url>${parent.url}</url>
+
+ <dependencyManagement>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-numbers-angle</artifactId>
+ <version>${version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-numbers-arrays</artifactId>
+ <version>${version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-numbers-combinatorics</artifactId>
+ <version>${version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-numbers-complex</artifactId>
+ <version>${version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-numbers-core</artifactId>
+ <version>${version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-numbers-field</artifactId>
+ <version>${version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-numbers-fraction</artifactId>
+ <version>${version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-numbers-gamma</artifactId>
+ <version>${version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-numbers-primes</artifactId>
+ <version>${version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-numbers-quaternion</artifactId>
+ <version>${version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-numbers-rootfinder</artifactId>
+ <version>${version}</version>
+ </dependency>
+ </dependencies>
+ </dependencyManagement>
+</project>
diff --git a/commons-numbers-bom/src/site/resources/style/module.css
b/commons-numbers-bom/src/site/resources/style/module.css
new file mode 100644
index 00000000..e27318bf
--- /dev/null
+++ b/commons-numbers-bom/src/site/resources/style/module.css
@@ -0,0 +1,19 @@
+/*
+ * 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.
+ */
+
+/* Match colour used for class declaration in prettyprint */
+.prettyprint, .lang-xml, .tag { color: teal; }
diff --git a/src/site/site.xml b/commons-numbers-bom/src/site/site.xml
similarity index 52%
copy from src/site/site.xml
copy to commons-numbers-bom/src/site/site.xml
index 13dc1688..d6fea36b 100644
--- a/src/site/site.xml
+++ b/commons-numbers-bom/src/site/site.xml
@@ -18,30 +18,15 @@
<project name="Numbers">
<bannerRight>
<name>Apache Commons Numbers</name>
- <src>/images/commons_numbers.small.png</src>
- <href>/index.html</href>
+ <!-- Use a full URL allows a correct banner for the modules. -->
+
<src>https://commons.apache.org/proper/commons-numbers/images/commons_numbers.small.png</src>
+ <href>https://commons.apache.org/proper/commons-numbers/index.html</href>
</bannerRight>
<body>
- <menu name="Numbers">
- <item name="Overview" href="/index.html"/>
- <item name="Downloads"
href="http://commons.apache.org/numbers/download_numbers.cgi"/>
- <item name="Issue Tracking" href="/issue-tracking.html"/>
- <item name="Source Repository (current)"
- href="http://gitbox.apache.org/repos/asf/commons-numbers.git"/>
- <!-- <item name="Wiki" -->
- <!-- href="http://wiki.apache.org/commons/Numbers"/> -->
- <item name="Developers Guide" href="/developers.html"/>
+ <menu name="Numbers Bill of Materials">
+ <item name="Overview" href="index.html"/>
</menu>
- <!-- <menu name="User Guide">
- <item name="Contents" href="/userguide/index.html"/>
- </menu> -->
-
- <head>
- <![CDATA[<script type="text/javascript"
src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML";>
- </script>]]>
- </head>
-
</body>
</project>
diff --git a/commons-numbers-bom/src/site/xdoc/index.xml
b/commons-numbers-bom/src/site/xdoc/index.xml
new file mode 100644
index 00000000..69b69b11
--- /dev/null
+++ b/commons-numbers-bom/src/site/xdoc/index.xml
@@ -0,0 +1,75 @@
+<?xml version="1.0"?>
+
+<!--
+ 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.
+ -->
+
+<document>
+
+ <properties>
+ <title>Commons Numbers Bill of Materials</title>
+ </properties>
+
+ <body>
+
+ <section name="Apache Commons Numbers: Number types and utilities"
href="summary">
+ <p>
+ Commons Numbers provides implementations of number types and utilities.
+ Features include
+ <ul>
+ <li>angles</li>
+ <li>arrays</li>
+ <li>combinatorics</li>
+ <li>complex numbers</li>
+ <li>core arithmetic</li>
+ <li>fields</li>
+ <li>fractions</li>
+ <li>gamma functions</li>
+ <li>primes</li>
+ <li>quaternions</li>
+ <li>root finding</li>
+ </ul>
+ </p>
+
+ <p>
+ The Bill of Materials (BOM) is provided to aid in
+ <a
href="https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#bill-of-materials-bom-poms";>dependency
management</a>
+ of the Apache Commons Numbers modules.
+ </p>
+
+ <p>
+ The BOM can be imported into a Maven pom to manage the module versions:
+ </p>
+
+<source class="prettyprint lang-xml"><![CDATA[
+<dependencyManagement>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-numbers-bom</artifactId>
+ <version>1.1</version>
+ <type>pom</type>
+ <scope>import</scope>
+ </dependency>
+ </dependencies>
+</dependencyManagement>
+]]></source>
+
+ </section>
+
+ </body>
+
+</document>
diff --git a/doc/release/release.howto.txt b/doc/release/release.howto.txt
index 80d0792d..4c43f726 100644
--- a/doc/release/release.howto.txt
+++ b/doc/release/release.howto.txt
@@ -237,6 +237,10 @@ In particular:
<!-- ... -->
</properties>
+ Other known locations of the project version:
+
+ commons-numbers-bom/src/site/xdoc/index.xml
+
(6)
The "download" page template is located at
"src/site/xdoc/download_numbers.xml".
@@ -282,7 +286,8 @@ Commit the updated files to git:
src/site/xdoc/download_numbers.xml \
RELEASE-NOTES.txt \
src/site/resources/release-notes/RELEASE-NOTES-* \
- src/site/xdoc/release-history.xml
+ src/site/xdoc/release-history.xml \
+ commons-numbers-bom/src/site/xdoc/index.xml
Check you did not forget any files:
@@ -420,7 +425,7 @@ and their associated fingerprints
and their signatures
<file-name>.asc
-The commons-numbers-parent artifact should contain the pom
+The commons-numbers-parent and commons-numbers-bom artifact should contain the
pom
and the associated fingerprints and signatures. The commons-parent also
contains a Software Package Data Exchange (SPDX) file.
@@ -428,6 +433,15 @@ Nexus used to add "md5" and "sha1" checksums files to the
"asc" files
(cryptographic signature). If these fingerprints on signatures are
present, they must be manually removed from Nexus staging area.
+***
+Note: The commons-numbers-bom artifact is deployed using the sign-and-deploy
goal
+of the maven gpg plugin. This still adds md5 and sha1 files for the artifact
asc
+files and these should be deleted.
+
+Select each .asc.md5 and .asc.sha1 file and delete the artifact. Then refresh
+the view and confirm the deletion.
+***
+
The process used to transfer the complete source and binaries distributions
files,
(for each module):
commons-numbers-<ModuleArtifactId>-1.0-bin.tar.gz
diff --git a/pom.xml b/pom.xml
index dc6a2b4d..eb6673f8 100644
--- a/pom.xml
+++ b/pom.xml
@@ -117,6 +117,7 @@
<module>commons-numbers-arrays</module>
<module>commons-numbers-field</module>
<module>commons-numbers-rootfinder</module>
+ <module>commons-numbers-bom</module>
</modules>
<scm>
@@ -224,17 +225,6 @@
<plugin>
<artifactId>maven-failsafe-plugin</artifactId>
</plugin>
- <plugin>
- <artifactId>maven-assembly-plugin</artifactId>
- <configuration>
- <descriptors>
- <descriptor>src/assembly/src.xml</descriptor>
- <descriptor>src/assembly/bin.xml</descriptor>
- </descriptors>
- <!-- There are a lot of long file names. Suppress the warnings. -->
- <tarLongFileMode>gnu</tarLongFileMode>
- </configuration>
- </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-scm-publish-plugin</artifactId>
@@ -344,6 +334,12 @@
<additionalOptions>${doclint.javadoc.qualifier}
${allowscript.javadoc.qualifier} -header '<script type="text/javascript"
src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/${numbers.mathjax.version}/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>'</additionalOptions>
</configuration>
</plugin>
+ <plugin>
+ <artifactId>maven-assembly-plugin</artifactId>
+ <configuration>
+ <skipAssembly>true</skipAssembly>
+ </configuration>
+ </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index e8f83a7b..ce0dba1e 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -53,8 +53,13 @@ If the output is not quite correct, check for invisible
trailing spaces!
</properties>
<body>
<release version="1.1" date="TBD" description="
-New features, updates and bug fixes (requires Java 8).
+New features, updates and bug fixes. Adds a commons-numbers-bom module.
Requires Java 8.
">
+ <action dev="aherbert" type="add" issue="NUMBERS-190">
+ Add a Bill of Materials (BOM) to aid in dependency management when
referencing multiple
+ Apache Commons Numbers artifacts. The BOM should be used to ensure all
imported artifacts are
+ compatible.
+ </action>
<action dev="aherbert" type="fix" issue="NUMBERS-185">
"Precision": Allow Precision.compareTo using a maxUlps to be used for
sorting.
This corrects handling of NaN comparisons.
diff --git a/src/site/site.xml b/src/site/site.xml
index 13dc1688..dcdf3d08 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -40,7 +40,8 @@
<head>
<![CDATA[<script type="text/javascript"
src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML";>
- </script>]]>
+ </script>
+ <link rel="stylesheet" href="$relativePath/style/module.css"
type="text/css" />]]>
</head>
</body>
