You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ah...@apache.org on 2023/02/16 12:27:35 UTC
[commons-statistics] 04/07: STATISTICS-66: Add a Bill of Materials (BOM) module
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-statistics.git
commit 13e6a9347c46f1a085695d84e83e13f695157b31
Author: aherbert <ah...@apache.org>
AuthorDate: Thu Feb 16 11:03:48 2023 +0000
STATISTICS-66: Add a Bill of Materials (BOM) module
---
commons-statistics-bom/LICENSE | 201 +++++++++++++
commons-statistics-bom/NOTICE | 5 +
commons-statistics-bom/README.md | 89 ++++++
commons-statistics-bom/pom.xml | 328 +++++++++++++++++++++
.../src/main/resources-filtered/bom.xml | 51 ++++
.../src/site/resources/style/module.css | 19 ++
commons-statistics-bom/src/site/site.xml | 32 ++
commons-statistics-bom/src/site/xdoc/index.xml | 61 ++++
pom.xml | 1 +
src/site/site.xml | 3 +-
10 files changed, 789 insertions(+), 1 deletion(-)
diff --git a/commons-statistics-bom/LICENSE b/commons-statistics-bom/LICENSE
new file mode 100644
index 0000000..261eeb9
--- /dev/null
+++ b/commons-statistics-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-statistics-bom/NOTICE b/commons-statistics-bom/NOTICE
new file mode 100644
index 0000000..ce3f323
--- /dev/null
+++ b/commons-statistics-bom/NOTICE
@@ -0,0 +1,5 @@
+Apache Commons Statistics
+Copyright 2018-2023 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
diff --git a/commons-statistics-bom/README.md b/commons-statistics-bom/README.md
new file mode 100644
index 0000000..be6af41
--- /dev/null
+++ b/commons-statistics-bom/README.md
@@ -0,0 +1,89 @@
+<!---
+ 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 Statistics (Bill of Materials)
+===================
+
+This Bill of Materials POM can be used to ease dependency management when referencing multiple Apache Commons Statistics artifacts.
+
+Documentation
+-------------
+
+More information can be found on the [Apache Commons Statistics homepage](https://commons.apache.org/proper/commons-statistics).
+Questions related to the usage of Apache Commons Statistics 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-statistics/download_statistics.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-statistics-bom</artifactId>
+ <version>1.0</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 Statistics? 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/STATISTICS)
++ [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-statistics-bom/pom.xml b/commons-statistics-bom/pom.xml
new file mode 100644
index 0000000..91b8b81
--- /dev/null
+++ b/commons-statistics-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-statistics-parent</artifactId>
+ <version>1.1-SNAPSHOT</version>
+ </parent>
+
+ <artifactId>commons-statistics-bom</artifactId>
+ <version>1.1-SNAPSHOT</version>
+ <name>Apache Commons Statistics (Bill of Materials)</name>
+ <packaging>pom</packaging>
+
+ <description>Bill of Materials (BOM) to aid in dependency management when referencing multiple Apache Commons Statistics artifacts.</description>
+
+ <!--
+ Note: This project pom is not the deployed BOM artifact.
+
+ This module inherits from commons-statistics-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 Statistics.
+
+ 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. -->
+ <statistics.parent.dir>${basedir}/..</statistics.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. -->
+ <statistics.bom.file>target/bom.xml</statistics.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. -->
+ <statistics.bom.snapshots.repositoryId>apache.snapshots.https</statistics.bom.snapshots.repositoryId>
+ <statistics.bom.snapshots.url>https://repository.apache.org/content/repositories/snapshots</statistics.bom.snapshots.url>
+ <statistics.bom.releases.repositoryId>apache.releases.https</statistics.bom.releases.repositoryId>
+ <statistics.bom.releases.url>https://repository.apache.org/service/local/staging/deploy/maven2</statistics.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.1-SNAPSHOT -> snapshots -> snapshots
+ Case 2: 1.1 -> 1.1 -> 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>${statistics.bom.snapshots.repositoryId}</replacement>
+ <failIfNoMatch>false</failIfNoMatch>
+ </regexPropertySetting>
+ <regexPropertySetting>
+ <name>bom.url.tmp</name>
+ <value>${project.version}</value>
+ <regex>.*-SNAPSHOT.*</regex>
+ <replacement>${statistics.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>${statistics.bom.releases.repositoryId}</replacement>
+ <failIfNoMatch>false</failIfNoMatch>
+ </regexPropertySetting>
+ <regexPropertySetting>
+ <name>bom.url</name>
+ <value>${bom.url.tmp}</value>
+ <regex>${project.version}</regex>
+ <replacement>${statistics.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>${statistics.bom.file}</file>
+ <!-- Collect group, artifact, version and packaging from the BOM -->
+ <pomFile>${statistics.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>
+ <statistics.bom.snapshots.repositoryId>test-deploy</statistics.bom.snapshots.repositoryId>
+ <statistics.bom.releases.repositoryId>test-deploy</statistics.bom.releases.repositoryId>
+ <statistics.bom.snapshots.url>file:target/deploy</statistics.bom.snapshots.url>
+ <statistics.bom.releases.url>file:target/deploy</statistics.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>${statistics.bom.file}</file>
+ <!-- Collect group, artifact, version and packaging from the BOM -->
+ <pomFile>${statistics.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>${statistics.bom.file}</file>
+ <!-- Collect group, artifact, version and packaging from the BOM -->
+ <pomFile>${statistics.bom.file}</pomFile>
+ <generatePom>false</generatePom>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+
+ </profiles>
+
+</project>
diff --git a/commons-statistics-bom/src/main/resources-filtered/bom.xml b/commons-statistics-bom/src/main/resources-filtered/bom.xml
new file mode 100644
index 0000000..4ac39c9
--- /dev/null
+++ b/commons-statistics-bom/src/main/resources-filtered/bom.xml
@@ -0,0 +1,51 @@
+<?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-statistics-distribution</artifactId>
+ <version>${version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-statistics-inference</artifactId>
+ <version>${version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-statistics-ranking</artifactId>
+ <version>${version}</version>
+ </dependency>
+ </dependencies>
+ </dependencyManagement>
+</project>
diff --git a/commons-statistics-bom/src/site/resources/style/module.css b/commons-statistics-bom/src/site/resources/style/module.css
new file mode 100644
index 0000000..e27318b
--- /dev/null
+++ b/commons-statistics-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/commons-statistics-bom/src/site/site.xml b/commons-statistics-bom/src/site/site.xml
new file mode 100644
index 0000000..098813c
--- /dev/null
+++ b/commons-statistics-bom/src/site/site.xml
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+ 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="Statistics">
+ <bannerRight>
+ <name>Apache Commons Statistics</name>
+ <!-- Use a full URL allows a correct banner for the modules. -->
+ <src>https://commons.apache.org/proper/commons-statistics/images/commons_statistics.small.png</src>
+ <href>https://commons.apache.org/proper/commons-statistics/index.html</href>
+ </bannerRight>
+
+ <body>
+ <menu name="Statistics Bill of Materials">
+ <item name="Overview" href="index.html"/>
+ </menu>
+
+ </body>
+</project>
diff --git a/commons-statistics-bom/src/site/xdoc/index.xml b/commons-statistics-bom/src/site/xdoc/index.xml
new file mode 100644
index 0000000..bead172
--- /dev/null
+++ b/commons-statistics-bom/src/site/xdoc/index.xml
@@ -0,0 +1,61 @@
+<?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 Statistics Bill of Materials</title>
+ </properties>
+
+ <body>
+
+ <section name="Apache Commons Statistics" href="summary">
+ <p>
+ Commons Statistics provides tools for statistics.
+ </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 Statistics 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-statistics-bom</artifactId>
+ <version>1.0</version>
+ <type>pom</type>
+ <scope>import</scope>
+ </dependency>
+ </dependencies>
+</dependencyManagement>
+]]></source>
+
+ </section>
+
+ </body>
+
+</document>
diff --git a/pom.xml b/pom.xml
index 02d7b05..f2fc0b1 100644
--- a/pom.xml
+++ b/pom.xml
@@ -640,6 +640,7 @@ This is avoided by creating an empty directory when svn is not available.
<module>commons-statistics-ranking</module>
<module>commons-statistics-inference</module>
<module>commons-statistics-regression</module>
+ <module>commons-statistics-bom</module>
</modules>
</project>
diff --git a/src/site/site.xml b/src/site/site.xml
index 48ac04d..84e3c2b 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -29,7 +29,8 @@
<body>
<head>
<![CDATA[<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
-<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>]]>
+<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
+<link rel="stylesheet" href="$relativePath/style/module.css" type="text/css" />]]>
</head>
<menu name="Statistics">