[Git][java-team/maven-reporting-api][upstream] 2 commits: New upstream version 3.1.0
Emmanuel Bourg (@ebourg)
gitlab at salsa.debian.org
Mon Oct 10 13:54:43 BST 2022
Emmanuel Bourg pushed to branch upstream at Debian Java Maintainers / maven-reporting-api
Commits:
d75b7b4d by Emmanuel Bourg at 2022-10-10T14:49:51+02:00
New upstream version 3.1.0
- - - - -
b7fe30c4 by Emmanuel Bourg at 2022-10-10T14:49:59+02:00
New upstream version 3.1.1
- - - - -
14 changed files:
- + .asf.yaml
- + .gitignore
- + Jenkinsfile
- + README.md
- pom.xml
- src/main/java/org/apache/maven/reporting/MavenMultiPageReport.java
- src/main/java/org/apache/maven/reporting/MavenReport.java
- src/main/java/org/apache/maven/reporting/MavenReportException.java
- src/main/java/org/apache/maven/reporting/MavenReportRenderer.java
- src/main/resources/default-report.xml
- − src/site/apt/index.apt
- + src/site/resources/download.cgi
- src/site/site.xml
- + src/site/xdoc/download.xml.vm
Changes:
=====================================
.asf.yaml
=====================================
@@ -0,0 +1,25 @@
+#
+# 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.
+#
+# see https://s.apache.org/asfyaml
+github:
+ description: "Apache Maven Reporting API"
+ homepage: https://maven.apache.org/shared/maven-reporting-api/
+ labels:
+ - java
+ - build-management
+ - maven-shared
+ - maven
=====================================
.gitignore
=====================================
@@ -0,0 +1,15 @@
+target/
+.project
+.classpath
+.settings/
+.svn/
+bin/
+# Intellij
+*.ipr
+*.iml
+.idea
+out/
+.DS_Store
+/bootstrap
+/dependencies.xml
+.java-version
=====================================
Jenkinsfile
=====================================
@@ -0,0 +1,20 @@
+/**
+ * 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.
+ */
+
+asfMavenTlpStdBuild()
=====================================
README.md
=====================================
@@ -0,0 +1,99 @@
+<!---
+ 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.
+-->
+Contributing to [Apache Maven Reporting API](https://maven.apache.org.reporting/maven-reporting-api/)
+======================
+
+[][jira]
+[][license]
+[](https://search.maven.org/artifact/org.apache.maven.reporting/maven-reporting-api)
+[][build]
+[][test-results]
+
+
+You have found a bug or you have an idea for a cool new feature? Contributing
+code is a great way to give something back to the open source community. Before
+you dig right into the code, there are a few guidelines that we need
+contributors to follow so that we can have a chance of keeping on top of
+things.
+
+Getting Started
+---------------
+
++ Make sure you have a [JIRA account](https://issues.apache.org/jira/).
++ Make sure you have a [GitHub account](https://github.com/signup/free).
++ If you're planning to implement a new feature, it makes sense to discuss your changes
+ on the [dev list][ml-list] first.
+ This way you can make sure you're not wasting your time on something that isn't
+ considered to be in Apache Maven's scope.
++ Submit a ticket for your issue, assuming one does not already exist.
+ + Clearly describe the issue, including steps to reproduce when it is a bug.
+ + Make sure you fill in the earliest version that you know has the issue.
++ Fork the repository on GitHub.
+
+Making and Submitting Changes
+--------------
+
+We accept Pull Requests via GitHub. The [developer mailing list][ml-list] is the
+main channel of communication for contributors.
+There are some guidelines which will make applying PRs easier for us:
++ Create a topic branch from where you want to base your work (this is usually the master branch).
+ Push your changes to a topic branch in your fork of the repository.
++ Make commits of logical units.
++ Respect the original code style: by using the same [codestyle][code-style],
+ patches should only highlight the actual difference, not being disturbed by any formatting issues:
+ + Only use spaces for indentation.
+ + 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.
+ + Check for unnecessary whitespace with `git diff --check` before committing.
++ Make sure your commit messages are in the proper format. Your commit message should contain the key of the JIRA issue.
+```
+[MSHARED-XXX] - Subject of the JIRA Ticket
+ Optional supplemental description.
+```
++ Make sure you have added the necessary tests (JUnit/IT) for your changes.
++ Run all the tests with `mvn -Prun-its verify` to assure nothing else was accidentally broken.
++ Submit a pull request to the repository in the Apache organization.
++ Update your JIRA ticket and include a link to the pull request in the ticket.
+
+If you plan to contribute on a regular basis, please consider filing a [contributor license agreement][cla].
+
+Making Trivial Changes
+----------------------
+
+For changes of a trivial nature to comments and documentation, it is not always
+necessary to create a new ticket in JIRA. In this case, it is appropriate to
+start the first line of a commit with '(doc)' instead of a ticket number..
+
+Additional Resources
+--------------------
+
++ [Contributing patches](https://maven.apache.org/guides/development/guide-maven-development.html#Creating_and_submitting_a_patch)
++ [Apache Maven Shared Components project page][jira]
++ [Contributor License Agreement][cla]
++ [General GitHub documentation](https://help.github.com/)
++ [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
++ [Apache Maven Twitter Account](https://twitter.com/ASFMavenProject)
++ #Maven IRC channel on freenode.org
+
+[jira]: https://issues.apache.org/jira/projects/MSHARED/
+[license]: https://www.apache.org/licenses/LICENSE-2.0
+[ml-list]: https://maven.apache.org/mailing-lists.html
+[code-style]: https://maven.apache.org/developers/conventions/code.html
+[cla]: https://www.apache.org/licenses/#clas
+[maven-wiki]: https://cwiki.apache.org/confluence/display/MAVEN/Index
+[test-results]: https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-reporting-api/job/master/lastCompletedBuild/testReport/
+[build]: https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-reporting-api/job/master/
=====================================
pom.xml
=====================================
@@ -25,14 +25,15 @@ under the License.
<parent>
<groupId>org.apache.maven.shared</groupId>
<artifactId>maven-shared-components</artifactId>
- <version>15</version>
+ <version>34</version>
+ <relativePath />
</parent>
<groupId>org.apache.maven.reporting</groupId>
<artifactId>maven-reporting-api</artifactId>
- <version>3.0</version>
+ <version>3.1.1</version>
- <name>Maven Reporting API</name>
+ <name>Apache Maven Reporting API</name>
<description>API to manage report generation.</description>
<developers>
@@ -48,21 +49,58 @@ under the License.
</developers>
<scm>
- <connection>scm:svn:http://svn.apache.org/repos/asf/maven/shared/tags/maven-reporting-api-3.0</connection>
- <developerConnection>scm:svn:https://svn.apache.org/repos/asf/maven/shared/tags/maven-reporting-api-3.0</developerConnection>
- <url>http://svn.apache.org/viewvc/maven/shared/tags/maven-reporting-api-3.0</url>
+ <connection>scm:git:https://gitbox.apache.org/repos/asf/maven-reporting-api.git</connection>
+ <developerConnection>scm:git:https://gitbox.apache.org/repos/asf/maven-reporting-api.git</developerConnection>
+ <url>https://github.com/apache/maven-reporting-api/tree/${project.scm.tag}</url>
+ <tag>maven-reporting-api-3.1.1</tag>
</scm>
-
<issueManagement>
<system>jira</system>
- <url>http://jira.codehaus.org/browse/MSHARED/component/14413</url>
+ <url>https://issues.apache.org/jira/issues/?jql=project%20%3D%20MSHARED%20AND%20component%20%3D%20maven-reporting-api</url>
</issueManagement>
+ <ciManagement>
+ <system>Jenkins</system>
+ <url>https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-reporting-api/</url>
+ </ciManagement>
+ <distributionManagement>
+ <site>
+ <id>apache.website</id>
+ <url>scm:svn:https://svn.apache.org/repos/asf/maven/website/components/${maven.site.path}</url>
+ </site>
+ </distributionManagement>
+
+ <properties>
+ <javaVersion>7</javaVersion>
+ <project.build.outputTimestamp>2022-07-29T20:27:56Z</project.build.outputTimestamp>
+ </properties>
+ <build>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>3.3.1</version>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-project-info-reports-plugin</artifactId>
+ <version>3.1.2</version>
+ </plugin>
+ </plugins>
+ </pluginManagement>
+ </build>
<dependencies>
<dependency>
<groupId>org.apache.maven.doxia</groupId>
<artifactId>doxia-sink-api</artifactId>
- <version>1.0</version>
+ <version>1.11.1</version>
+ <exclusions>
+ <exclusion>
+ <artifactId>plexus-container-default</artifactId>
+ <groupId>org.codehaus.plexus</groupId>
+ </exclusion>
+ </exclusions>
</dependency>
</dependencies>
</project>
=====================================
src/main/java/org/apache/maven/reporting/MavenMultiPageReport.java
=====================================
@@ -36,6 +36,13 @@ import java.util.Locale;
public interface MavenMultiPageReport
extends MavenReport
{
+ /**
+ * Generate multi page report.
+ *
+ * @param sink The sink to write to.
+ * @param locale The locale to use.
+ * @throws MavenReportException if an error occurs.
+ */
void generate( Sink sink, SinkFactory sinkFactory, Locale locale )
throws MavenReportException;
}
=====================================
src/main/java/org/apache/maven/reporting/MavenReport.java
=====================================
@@ -30,7 +30,6 @@ import java.util.Locale;
* @author Brett Porter
* @author <a href="evenisse at apache.org">Emmanuel Venisse</a>
* @author <a href="mailto:vincent.siveton at gmail.com">Vincent Siveton</a>
- * @version $Id: MavenReport.java 942378 2010-05-08 13:06:13Z hboutemy $
* @since 2.0
*/
public interface MavenReport
@@ -46,7 +45,7 @@ public interface MavenReport
/**
* Generate the report depending the wanted locale.
- * <br/>
+ * <br>
* Mainly used for external reports like javadoc.
*
* @param sink the sink to use for the generation.
@@ -103,16 +102,16 @@ public interface MavenReport
* An external report is a report which calls a third party program which generates some reports too.
* A good example is javadoc tool.
*
- * @return <tt>true</tt> if this report is external, <tt>false</tt> otherwise.
- * Default should be <tt>false</tt>.
+ * @return {@code true} if this report is external, {@code false} otherwise.
+ * Default should be {@code false}.
*/
boolean isExternalReport();
/**
* Verify some conditions before generate the report.
*
- * @return <tt>true</tt> if this report could be generated, <tt>false</tt> otherwise.
- * Default should be <tt>true</tt>.
+ * @return {@code true} if this report could be generated, {@code false} otherwise.
+ * Default should be {@code true}.
*/
boolean canGenerateReport();
}
=====================================
src/main/java/org/apache/maven/reporting/MavenReportException.java
=====================================
@@ -24,7 +24,6 @@ package org.apache.maven.reporting;
*
* @author Brett Porter
* @author <a href="evenisse at apache.org">Emmanuel Venisse</a>
- * @version $Id: MavenReportException.java 942378 2010-05-08 13:06:13Z hboutemy $
* @since 2.0
*/
public class MavenReportException
=====================================
src/main/java/org/apache/maven/reporting/MavenReportRenderer.java
=====================================
@@ -24,9 +24,8 @@ package org.apache.maven.reporting;
*
* @author <a href="mailto:jason at maven.org">Jason van Zyl</a>
* @author <a href="evenisse at apache.org">Emmanuel Venisse</a>
- * @version $Id: MavenReportRenderer.java 940199 2010-05-02 12:21:33Z hboutemy $
* @since 2.0
- * @TODO Later it may be appropriate to create something like a VelocityMavenReportRenderer
+ * TODO Later it may be appropriate to create something like a VelocityMavenReportRenderer
* that could take a velocity template and pipe that through Doxia rather than coding
* them up like this.
*/
=====================================
src/main/resources/default-report.xml
=====================================
@@ -20,6 +20,6 @@ under the License.
<project name="${project.name}">
<body>
- ${reports}
+ <menu ref="reports"/>
</body>
</project>
=====================================
src/site/apt/index.apt deleted
=====================================
@@ -1,14 +0,0 @@
- -----
- Maven Reporting API
- -----
- Hervé Boutemy
- -----
- 2010-05-08
- -----
-
-Maven Reporting API
-
- API to manage report generation.
-
- <<<maven-reporting-api>>> is included in Maven 2.x core distribution, but moved to
- shared components to achieve report decoupling from Maven 3 core.
=====================================
src/site/resources/download.cgi
=====================================
@@ -0,0 +1,22 @@
+#!/bin/sh
+#
+# 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.
+#
+# Just call the standard mirrors.cgi script. It will use download.html
+# as the input template.
+exec /www/www.apache.org/dyn/mirrors/mirrors.cgi $*
\ No newline at end of file
=====================================
src/site/site.xml
=====================================
@@ -1,4 +1,5 @@
<?xml version="1.0"?>
+
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
@@ -20,7 +21,17 @@ under the License.
<project xmlns="http://maven.apache.org/DECORATION/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
<body>
+ <menu name="Overview">
+ <item name="Introduction" href="index.html"/>
+ <item name="Javadoc" href="apidocs/index.html"/>
+ <item name="Source Xref" href="xref/index.html"/>
+ <!--item name="FAQ" href="faq.html"/-->
+ <!-- According to https://issues.apache.org/jira/browse/MNGSITE-152 -->
+ <item name="License" href="http://www.apache.org/licenses/"/>
+ <item name="Download" href="download.html"/>
+ </menu>
+
<menu ref="parent"/>
<menu ref="reports"/>
</body>
-</project>
\ No newline at end of file
+</project>
=====================================
src/site/xdoc/download.xml.vm
=====================================
@@ -0,0 +1,126 @@
+<?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>Download ${project.name} Source</title>
+ </properties>
+ <body>
+ <section name="Download ${project.name} ${project.version} Source">
+
+ <p>${project.name} ${project.version} is distributed in source format. Use a source archive if you intend to build
+ ${project.name} yourself. Otherwise, simply use the ready-made binary artifacts from central repository.</p>
+
+ <p>You will be prompted for a mirror - if the file is not found on yours, please be patient, as it may take 24
+ hours to reach all mirrors.<p/>
+
+ <p>In order to guard against corrupted downloads/installations, it is highly recommended to
+ <a href="http://www.apache.org/dev/release-signing#verifying-signature">verify the signature</a>
+ of the release bundles against the public <a href="https://www.apache.org/dist/maven/KEYS">KEYS</a> used by the Apache Maven
+ developers.</p>
+
+ <p>${project.name} is distributed under the <a href="http://www.apache.org/licenses/">Apache License, version 2.0</a>.</p>
+
+ <p></p>We <b>strongly</b> encourage our users to configure a Maven repository mirror closer to their location, please read <a href="/guides/mini/guide-mirror-settings.html">How to Use Mirrors for Repositories</a>.</p>
+
+ <a name="mirror"/>
+ <subsection name="Mirror">
+
+ <p>
+ [if-any logo]
+ <a href="[link]">
+ <img align="right" src="[logo]" border="0"
+ alt="logo"/>
+ </a>
+ [end]
+ The currently selected mirror is
+ <b>[preferred]</b>.
+ If you encounter a problem with this mirror,
+ please select another mirror.
+ If all mirrors are failing, there are
+ <i>backup</i>
+ mirrors
+ (at the end of the mirrors list) that should be available.
+ </p>
+
+ <form action="[location]" method="get" id="SelectMirror">
+ Other mirrors:
+ <select name="Preferred">
+ [if-any http]
+ [for http]
+ <option value="[http]">[http]</option>
+ [end]
+ [end]
+ [if-any ftp]
+ [for ftp]
+ <option value="[ftp]">[ftp]</option>
+ [end]
+ [end]
+ [if-any backup]
+ [for backup]
+ <option value="[backup]">[backup] (backup)</option>
+ [end]
+ [end]
+ </select>
+ <input type="submit" value="Change"/>
+ </form>
+
+ <p>
+ You may also consult the
+ <a href="http://www.apache.org/mirrors/">complete list of
+ mirrors.</a>
+ </p>
+
+ </subsection>
+
+ <subsection name="${project.name} ${project.version}">
+
+ <p>This is the current stable version of ${project.name}.</p>
+
+ <table>
+ <thead>
+ <tr>
+ <th></th>
+ <th>Link</th>
+ <th>Checksum</th>
+ <th>Signature</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>${project.name} ${project.version} (Source zip)</td>
+ <td><a href="[preferred]maven/reporting/${project.artifactId}-${project.version}-source-release.zip">maven/reporting/${project.artifactId}-${project.version}-source-release.zip</a></td>
+ <td><a href="https://www.apache.org/dist/maven/reporting/${project.artifactId}-${project.version}-source-release.zip.sha512">maven/reporting/${project.artifactId}-${project.version}-source-release.zip.sha512</a></td>
+ <td><a href="https://www.apache.org/dist/maven/reporting/${project.artifactId}-${project.version}-source-release.zip.asc">maven/reporting/${project.artifactId}-${project.version}-source-release.zip.asc</a></td>
+ </tr>
+ </tbody>
+ </table>
+ </subsection>
+
+ <subsection name="Previous Versions">
+
+ <p>Older non-recommended releases can be found on our <a href="http://archive.apache.org/dist/maven/reporting/">archive site</a>.</p>
+
+ </subsection>
+ </section>
+ </body>
+</document>
+
View it on GitLab: https://salsa.debian.org/java-team/maven-reporting-api/-/compare/a270b06dec6c677b00178b6cd222426c0a0004a0...b7fe30c42e4abe016999768a649db231692a8b2e
--
View it on GitLab: https://salsa.debian.org/java-team/maven-reporting-api/-/compare/a270b06dec6c677b00178b6cd222426c0a0004a0...b7fe30c42e4abe016999768a649db231692a8b2e
You're receiving this email because of your account on salsa.debian.org.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://alioth-lists.debian.net/pipermail/pkg-java-commits/attachments/20221010/ab23eace/attachment.htm>
More information about the pkg-java-commits
mailing list