diff --git a/maven-plugins/maven-project-info-reports-plugin/pom.xml b/maven-plugins/maven-project-info-reports-plugin/pom.xml index 88ac9b2a14..f2ed0be987 100644 --- a/maven-plugins/maven-project-info-reports-plugin/pom.xml +++ b/maven-plugins/maven-project-info-reports-plugin/pom.xml @@ -22,6 +22,12 @@ -5 + + + Johnny R. Ruiz III + jruiz@exist.com + + org.apache.maven.scm diff --git a/maven-plugins/maven-project-info-reports-plugin/src/site/apt/howto.apt b/maven-plugins/maven-project-info-reports-plugin/src/site/apt/howto.apt new file mode 100644 index 0000000000..53e63e8308 --- /dev/null +++ b/maven-plugins/maven-project-info-reports-plugin/src/site/apt/howto.apt @@ -0,0 +1,101 @@ + ------ + Maven 2 Project Info Report Plugin + ------ + Johnny R. Ruiz III + + ------ + September 20, 2005 + +How to Use + + This plugin consists of several reports that you can run selectively, individually or even run all of them. Please see below for instructions + on how to configure your pom.xml to do this. + + +*Run All Reports + + To include all Project Info Reports in your project, you must configure your pom.xml. + Use "m2 site:site" to generate the configured reports. + +------------------- + + ... + + ... + + + org.apache.maven.plugins + maven-project-info-reports-plugin + + + ... + + ... + +------------------- + +*Run Selective Reports + + To run the reports selectively, you can configure it to include only the reports that you prefer. + Use "m2 site:site" to generate the selected reports. + +------------------- + + + ... + + ... + + + org.apache.maven.plugins + maven-project-info-reports-plugin + + + + dependencies + project-team + mailing-list + cim + issue-tracking + license + scm + + + + + + ... + + ... + +------------------- + +*Run Individual Report + + How to run the reports directly without configuring anything from the pom.xml? + +*---------------------------------+----------------------------------------------+ +|<> | <> | +| | | +*---------------------------------+----------------------------------------------+ +|Dependencies Report | m2 project-info-reports:dependencies | +*---------------------------------+----------------------------------------------+ +|Mailing Lists | m2 project-info-reports:mailing-list | +*---------------------------------+----------------------------------------------+ +|Continous Integration | m2 project-info-reports:cim | +*---------------------------------+----------------------------------------------+ +|Source Repository | m2 project-info-reports:scm | +*---------------------------------+----------------------------------------------+ +|Issue Tracking | m2 project-info-reports:issue-tracking | +*---------------------------------+----------------------------------------------+ +|Project Team | m2 project-info-reports:project-team | +*---------------------------------+----------------------------------------------+ +|License | m2 project-info-reports:license | +*---------------------------------+----------------------------------------------+ + + + + For full documentation, click {{{index.html}here}}. + + + diff --git a/maven-plugins/maven-project-info-reports-plugin/src/site/apt/introduction.apt b/maven-plugins/maven-project-info-reports-plugin/src/site/apt/introduction.apt new file mode 100644 index 0000000000..286fdf9b07 --- /dev/null +++ b/maven-plugins/maven-project-info-reports-plugin/src/site/apt/introduction.apt @@ -0,0 +1,33 @@ + ------ + Maven 2 Project Info Reports Plugin + ------ + Johnny R. Ruiz III + + ------ + September 22, 2005 + +Introduction + + This is a plugin that generates reports information about the project. The reports being generated are as follows: + +*---------------------------------+-------------------------------------------------------------------------------+ +|<> | <> | +| | | +*---------------------------------+-------------------------------------------------------------------------------+ +|Dependencies Report | Project Dependencies and Transitive Dependencies Report | +*---------------------------------+-------------------------------------------------------------------------------+ +|Mailing Lists | Project Mailing List | +*---------------------------------+-------------------------------------------------------------------------------+ +|Continous Integration | Continous Integration used by the Project (System Name, URL, Notifiers) | +*---------------------------------+-------------------------------------------------------------------------------+ +|Source Repository | Source Code Manager used by the Project. This report shows how to access | +| | the source code (Anonymous access, Dev access, Web access, etc.) | +*---------------------------------+-------------------------------------------------------------------------------+ +|Issue Tracking | Issue Tracking System used by the Project. (URL) | +*---------------------------------+-------------------------------------------------------------------------------+ +|Project Team | Project Team Members, Developers, and Contributors | +*---------------------------------+-------------------------------------------------------------------------------+ +|License | License of the project | +*---------------------------------+-------------------------------------------------------------------------------+ + + diff --git a/maven-plugins/maven-project-info-reports-plugin/src/site/resources/sample-dependencies.html b/maven-plugins/maven-project-info-reports-plugin/src/site/resources/sample-dependencies.html new file mode 100644 index 0000000000..f1c82d10a2 --- /dev/null +++ b/maven-plugins/maven-project-info-reports-plugin/src/site/resources/sample-dependencies.html @@ -0,0 +1,118 @@ + + + + + + + + + + Welcome to Maven Project Info Reports Plugin + + + + + + + +
+
+
+

Project Dependencies

The following is a list of dependencies for this project. These dependencies are required to compile and run the application:
GroupIdArtifactIdVersionDescriptionURL
org.apache.maven.scmmaven-scm-provider-perforce1.0-alpha-2--
org.apache.maven.scmmaven-scm-provider-starteam1.0-alpha-2--
commons-validatorcommons-validator1.1.4--
junitjunit3.8.1--
org.apache.maven.reportingmaven-reporting-impl2.0-beta-1Maven components parenthttp://maven.apache.org/maven2/maven-reporting/maven-reporting-impl
org.apache.maven.scmmaven-scm-provider-clearcase1.0-alpha-2--
org.apache.mavenmaven-model2.0-beta-1Maven Modelhttp://maven.apache.org/maven2/maven-model
org.apache.maven.scmmaven-scm-provider-svn1.0-alpha-2--
org.apache.maven.scmmaven-scm-manager-plexus1.0-alpha-2--
org.apache.maven.scmmaven-scm-api1.0-alpha-2--
org.apache.maven.scmmaven-scm-provider-cvs1.0-alpha-2--
org.apache.mavenmaven-plugin-api2.0-beta-1Maven components parenthttp://maven.apache.org/maven2/maven-plugin-api

Project Transitive Dependencies

The following is a list of transitive dependencies for this project. Transitive dependencies are the dependencies of the project dependencies:
GroupIdArtifactIdVersionDescriptionURL
org.apache.maven.wagonwagon-provider-api1.0-alpha-4Tools to manage artifacts and deployment-
plexusplexus-utils1.0.3--
org.apache.mavenmaven-artifact-manager2.0-beta-1Maven components parenthttp://maven.apache.org
orooro2.0.7--
doxiadoxia-core1.0-alpha-4--
classworldsclassworlds1.1-alpha-2-http://classworlds.codehaus.org/
org.apache.mavenmaven-repository-metadata2.0-beta-1Maven Plugin Mappinghttp://maven.apache.org/maven2/maven-repository-metadata
org.apache.mavenmaven-profile2.0-beta-1Maven components parenthttp://maven.apache.org/maven2/maven-profile
plexusplexus-container-default1.0-alpha-5--
org.apache.mavenmaven-project2.0-beta-1This library is used to not only read Maven project object model files, but to assemble inheritence + and to retrieve remote models as required.http://maven.apache.org/maven2/maven-project
org.apache.mavenmaven-artifact2.0-beta-1Maven components parenthttp://maven.apache.org/maven2/maven-artifact
org.apache.maven.reportingmaven-reporting-api2.0-beta-1Maven components parenthttp://maven.apache.org/maven2/maven-reporting/maven-reporting-api
doxiadoxia-sink-api1.0-alpha-4--
regexpregexp1.3--
+
+
+
+
+
+ + + diff --git a/maven-plugins/maven-project-info-reports-plugin/src/site/resources/sample-integration.html b/maven-plugins/maven-project-info-reports-plugin/src/site/resources/sample-integration.html new file mode 100644 index 0000000000..48a706050a --- /dev/null +++ b/maven-plugins/maven-project-info-reports-plugin/src/site/resources/sample-integration.html @@ -0,0 +1,117 @@ + + + + + + + + + + Welcome to Maven Project Info Reports Plugin + + + + + + + +
+
+
+

Overview

This project uses Continuum.

Access

No url to the continuous integration system is defined.

Notifiers

Configuration for notifying developers/users when a build is unsuccessful, including user information and notification mode.
TypeAddressConfiguration
mail-address=dev@maven.apache.org
+
+
+
+
+
+ + + diff --git a/maven-plugins/maven-project-info-reports-plugin/src/site/resources/sample-issue-tracking.html b/maven-plugins/maven-project-info-reports-plugin/src/site/resources/sample-issue-tracking.html new file mode 100644 index 0000000000..ae57c3cc32 --- /dev/null +++ b/maven-plugins/maven-project-info-reports-plugin/src/site/resources/sample-issue-tracking.html @@ -0,0 +1,117 @@ + + + + + + + + + + Welcome to Maven Project Info Reports Plugin + + + + + + + +
+
+
+

Overview

This project uses Jira a J2EE-based, issue tracking and project management application.

Issue Tracking

Issues, bugs, and feature requests should be submitted to the following issue tracking system for this project.

+
+
+
+
+
+ + + diff --git a/maven-plugins/maven-project-info-reports-plugin/src/site/resources/sample-license.html b/maven-plugins/maven-project-info-reports-plugin/src/site/resources/sample-license.html new file mode 100644 index 0000000000..8ea3a0c437 --- /dev/null +++ b/maven-plugins/maven-project-info-reports-plugin/src/site/resources/sample-license.html @@ -0,0 +1,319 @@ + + + + + + + + + + Welcome to Maven Project Info Reports Plugin + + + + + + + +
+
+
+

Overview

Typically the licenses listed for the project are that of the project itself, and not of dependencies.

Project License

The Apache Software License, Version 2.0

+                                 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/maven-plugins/maven-project-info-reports-plugin/src/site/resources/sample-mail-lists.html b/maven-plugins/maven-project-info-reports-plugin/src/site/resources/sample-mail-lists.html new file mode 100644 index 0000000000..5711215420 --- /dev/null +++ b/maven-plugins/maven-project-info-reports-plugin/src/site/resources/sample-mail-lists.html @@ -0,0 +1,117 @@ + + + + + + + + + + Welcome to Maven Project Info Reports Plugin + + + + + + + +
+
+
+

Project Mailing Lists

These are the mailing lists that have been established for this project. For each list, there is a subscribe, unsubscribe, and an archive link.

NameSubscribeUnsubscribePostArchive
Maven User ListSubscribeUnsubscribePostmail-archives.apache.org
Maven Developer ListSubscribeUnsubscribePostmail-archives.apache.org
+
+
+
+
+
+ + + diff --git a/maven-plugins/maven-project-info-reports-plugin/src/site/resources/sample-source-repository.html b/maven-plugins/maven-project-info-reports-plugin/src/site/resources/sample-source-repository.html new file mode 100644 index 0000000000..2ea5ba4b52 --- /dev/null +++ b/maven-plugins/maven-project-info-reports-plugin/src/site/resources/sample-source-repository.html @@ -0,0 +1,122 @@ + + + + + + + + + + Welcome to Maven Project Info Reports Plugin + + + + + + + +
+
+
+

Overview

This project uses Subversion to manage its source code. Instructions on Subversion use can be found at http://svnbook.red-bean.com/.

Anonymous access

The source can be checked out anonymously from SVN with this command:

$ svn checkout http://svn.apache.org/repos/asf/maven/components/trunk/maven-plugins/maven-project-info-reports-plugin2 maven-project-info-reports-plugin2

Developer access

Everyone can access the Subversion repository via HTTPS, but Committers must checkout the Subversion repository via HTTPS.

$ svn checkout https://svn.apache.org/repos/asf/maven/components/trunk/maven-plugins/maven-project-info-reports-plugin2 maven-project-info-reports-plugin2

To commit changes to the repository, execute the following command to commit your changes (svn will prompt you for your password)

$ svn commit --username your-username -m "A message"

Access from behind a firewall

For those users who are stuck behind a corporate firewall which is blocking http access to the Subversion repository, you can try to access it via the developer connection:

$ svn checkout https://svn.apache.org/repos/asf/maven/components/trunk/maven-plugins/maven-project-info-reports-plugin2 maven-project-info-reports-plugin2

Access through a proxy

The Subversion client can go through a proxy, if you configure it to do so. First, edit your "servers" configuration file to indicate which proxy to use. The files location depends on your operating system. On Linux or Unix it is located in the directory "~/.subversion". On Windows it is in "%APPDATA%\Subversion". (Try "echo %APPDATA%", note this is a hidden directory.)

There are comments in the file explaining what to do. If you don't have that file, get the latest Subversion client and run any command; this will cause the configuration directory and template files to be created.

Example : Edit the 'servers' file and add something like :

[global]
+http-proxy-host = your.proxy.name
+http-proxy-port = 3128
+
+
+
+
+
+
+ + + diff --git a/maven-plugins/maven-project-info-reports-plugin/src/site/resources/sample-team-list.html b/maven-plugins/maven-project-info-reports-plugin/src/site/resources/sample-team-list.html new file mode 100644 index 0000000000..d9c8c9a0a9 --- /dev/null +++ b/maven-plugins/maven-project-info-reports-plugin/src/site/resources/sample-team-list.html @@ -0,0 +1,135 @@ + + + + + + + + + + Welcome to Maven Project Info Reports Plugin + + + + + + + +
+
+
+

The Team

A successful project requires many people to play many roles. Some members write code or documentation, while others are valuable as testers, submitting patches and suggestions.

The team is comprised of Members and Contributors. Members have direct access to the source of a project and actively evolve the code-base. Contributors improve the project through submission of patches and suggestions to the Members. The number of Contributors to the project is unbounded. Get involved today. All contributions to the project are greatly appreciated.

Members

The following is a list of developers with commit privileges that have directly contributed to the project in one way or another.

IdNameEmailURLOrganizationOrganization URLRolesTime ZoneActual Time (GMT)Properties
vsivetonVincent Sivetonvsiveton@apache.org-Apache Software Foundation-Java Developer-5-5-

Contributors

There are no contributors listed for this project. Please check back again later.

+
+
+
+
+
+ + + diff --git a/maven-plugins/maven-project-info-reports-plugin/src/site/site.xml b/maven-plugins/maven-project-info-reports-plugin/src/site/site.xml new file mode 100644 index 0000000000..5d91d637ef --- /dev/null +++ b/maven-plugins/maven-project-info-reports-plugin/src/site/site.xml @@ -0,0 +1,50 @@ + + + + + + + Maven Project Info Reports Plugin + http://maven.apache.org/images/apache-maven-project.png + http://maven.apache.org/ + + + http://maven.apache.org/images/maven-small.gif + + + + + + + + + + + + + + + + + + + + ${reports} + +