You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2020/06/19 11:50:08 UTC
[maven-artifact-plugin] branch master updated: renamed maven-buildinfo-plugin to maven-artifact-plugin

This is an automated email from the ASF dual-hosted git repository.

hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-artifact-plugin.git


The following commit(s) were added to refs/heads/master by this push:
     new 1a3fc39  renamed maven-buildinfo-plugin to maven-artifact-plugin
1a3fc39 is described below

commit 1a3fc396299231a6b46f5b82b14a6abba0eec406
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Fri Jun 19 13:46:42 2020 +0200

    renamed maven-buildinfo-plugin to maven-artifact-plugin
---
 README.md                                          | 93 ++++++++++++++++++----
 pom.xml                                            | 23 +++---
 .../{ => artifact}/buildinfo/BuildInfoWriter.java  |  2 +-
 .../{ => artifact}/buildinfo/BuildinfoMojo.java    |  2 +-
 .../{ => artifact}/buildinfo/DigestHelper.java     |  2 +-
 .../{ => artifact}/buildinfo/MavenVersion.java     |  2 +-
 .../buildinfo/ReferenceBuildinfoUtil.java          |  2 +-
 .../plugins/{ => artifact}/buildinfo/SaveMojo.java |  2 +-
 8 files changed, 97 insertions(+), 31 deletions(-)

diff --git a/README.md b/README.md
index 58a1b7b..36f7d18 100644
--- a/README.md
+++ b/README.md
@@ -14,18 +14,28 @@
  See the License for the specific language governing permissions and
  limitations under the License.
 -->
-Apache Maven Buildinfo Plugin Study
+Contributing to [Apache Maven Artifact Plugin](https://maven.apache.org/plugins/maven-artifact-plugin/)
 ======================
 
+[![ASF Jira](https://img.shields.io/endpoint?url=https%3A%2F%2Fmaven.apache.org%2Fbadges%2Fasf_jira-MARTIFACT.json)][jira]
 [![Apache License, Version 2.0, January 2004](https://img.shields.io/github/license/apache/maven.svg?label=License)][license]
+[![Maven Central](https://img.shields.io/maven-central/v/org.apache.maven.plugins/maven-artifact-plugin.svg?label=Maven%20Central)](https://search.maven.org/artifact/org.apache.maven.plugins/maven-artifact-plugin)
+[![Jenkins Status](https://img.shields.io/jenkins/s/https/builds.apache.org/job/maven-box/job/maven-artifact-plugin/job/master.svg?)][build]
+[![Jenkins tests](https://img.shields.io/jenkins/t/https/builds.apache.org/job/maven-box/job/maven-artifact-plugin/job/master.svg?)][test-results]
 
-This plugin is a study, written as a Proof Of Concept of [Reproducible Builds](https://reproducible-builds.org/) tooling
-to ease reproducing Maven builds that are [expected to be reproducible](https://maven.apache.org/guides/mini/guide-reproducible-builds.html): once [feedback](https://lists.apache.org/thread.html/ra05a971a2de961d27691bd4624850a06a862b4223116c0c904be8397%40%3Cdev.maven.apache.org%3E) will be given on Maven developper mailing list, we'll see if this will be moved
-to a separate Maven plugin or if its unique goal will be merged to an existing plugin.
 
-The purpose of this plugin is:
+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.
 
-- to generate a buildinfo file from a build recording fingerprints of output files, as specified in [Reproducible Builds for the JVM](https://reproducible-builds.org/docs/jvm/)
+This plugin contains `buildinfo`goal for [Reproducible Builds](https://reproducible-builds.org/) tooling,
+to ease reproducing Maven builds that are [expected to be reproducible](https://maven.apache.org/guides/mini/guide-reproducible-builds.html).
+
+The purpose of this goal is:
+
+- to generate a buildinfo file from a build, recording fingerprints of output files, as specified in [Reproducible Builds for the JVM](https://reproducible-builds.org/docs/jvm/)
   that will eventually be deployed to remote repository
 
 - help rebuilders to check that they local build produces the same Reproducible Build output than the reference build
@@ -37,7 +47,7 @@ Generating buildinfo after a build
 --------------
 
 ```
-mvn verify buildinfo:buildinfo
+mvn verify artifact:buildinfo
 ```
 
 Deploy to remote repository
@@ -52,24 +62,79 @@ Check local build against remote reference
 If reference build is available in a remote repository with predefined id, like ```central```:
 
 ```
-mvn verify buildinfo:buildinfo -Dreference.repo=central
+mvn verify artifact:buildinfo -Dreference.repo=central
 ```
 
 If reference build is available in a remote repository without predefined id, use its url instead:
 
 ```
-mvn verify buildinfo:buildinfo -Dreference.repo=https://repository.apache.org/content/groups/maven-staging-group/
+mvn verify artifact:buildinfo -Dreference.repo=https://repository.apache.org/content/groups/maven-staging-group/
 ```
 
-Available Reproducible Releases in Maven Central Repository 
+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
 --------------
 
-- [org.apache.maven.plugins:maven-shade-plugin:3.2.2](https://repo.maven.apache.org/maven2/org/apache/maven/plugins/maven-shade-plugin/3.2.2/) mono-module, with source-release
+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.
+```
+[MARTIFACT-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
+----------------------
 
-- [org.apache;maven.doxia:doxia:1.9.1](https://repo.maven.apache.org/maven2/org/apache/maven/doxia/doxia/1.9.1/) multi-module, with source-release
+For changes of a trivial nature to comments and documentation, it is not always
+necessary to create a new ticket in JIRA.  In this case, it is appropriate to
+start the first line of a commit with '(doc)' instead of a ticket number.
 
-- [info.guardianproject:jtorctl:0.4](https://repo.maven.apache.org/maven2/info/guardianproject/jtorctl/0.4/) mono-module with provided buildinfo
+Additional Resources
+--------------------
 
-- [org.apache.sling:org.apache.sling.installer.core:3.10.2](https://repo.maven.apache.org/maven2/org/apache/sling/org.apache.sling.installer.core/3.10.2/) OSGI, with source-release
++ [Contributing patches](https://maven.apache.org/guides/development/guide-maven-development.html#Creating_and_submitting_a_patch)
++ [Apache Maven Artifact Plugin JIRA 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/MARTIFACT/
 [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://builds.apache.org/job/maven-box/job/maven-artifact-plugin/job/master/lastCompletedBuild/testReport/
+[build]: https://builds.apache.org/job/maven-box/job/maven-artifact-plugin/job/master/
diff --git a/pom.xml b/pom.xml
index c1ab506..f7b6fec 100644
--- a/pom.xml
+++ b/pom.xml
@@ -30,31 +30,31 @@
     <relativePath>../../pom/maven/maven-plugins/pom.xml</relativePath>
   </parent>
 
-  <artifactId>maven-buildinfo-plugin</artifactId>
+  <artifactId>maven-artifact-plugin</artifactId>
   <version>1.0-SNAPSHOT</version>
   <packaging>maven-plugin</packaging>
 
-  <name>Apache Maven Buildinfo Plugin</name>
-  <description>Plugin to manage Reproducible Builds buildinfo file</description>
+  <name>Apache Maven Artifact Plugin</name>
+  <description>Plugin to manage artifacts tasks</description>
 
   <prerequisites>
     <maven>${maven.version}</maven>
   </prerequisites>
 
   <scm>
-    <connection>scm:git:https://gitbox.apache.org/repos/asf/maven-studies.git</connection>
-    <developerConnection>scm:git:https://gitbox.apache.org/repos/asf/maven-studies.git</developerConnection>
-    <url>https://github.com/apache/maven-studies/tree/${project.scm.tag}</url>
-    <tag>maven-buildinfo-plugin</tag>
+    <connection>scm:git:https://gitbox.apache.org/repos/asf/maven-artifact-plugin.git</connection>
+    <developerConnection>scm:git:https://gitbox.apache.org/repos/asf/maven-artifact-plugin.git</developerConnection>
+    <url>https://github.com/apache/maven-artifact-plugin/tree/${project.scm.tag}</url>
+    <tag>master</tag>
   </scm>
   <!-->issueManagement>
     <system>JIRA</system>
     <url>https://issues.apache.org/jira/browse/MJAR</url>
-  </issueManagement>
+  </issueManagement-->
   <ciManagement>
     <system>Jenkins</system>
-    <url>https://builds.apache.org/job/maven-box/job/maven-jar-plugin/</url>
-  </ciManagement-->
+    <url>https://builds.apache.org/job/maven-box/job/maven-artifact-plugin/</url>
+  </ciManagement>
   <distributionManagement>
     <site>
       <id>apache.website</id>
@@ -65,6 +65,7 @@
   <properties>
     <mavenVersion>3.0</mavenVersion>
     <javaVersion>7</javaVersion>
+    <project.build.outputTimestamp>2020-04-12T07:51:40Z</project.build.outputTimestamp>
   </properties>
 
   <dependencies>
@@ -163,7 +164,7 @@
         <plugins>
           <plugin>
             <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-buildinfo-plugin</artifactId>
+            <artifactId>maven-artifact-plugin</artifactId>
             <version>${project.version}</version>
             <executions>
               <execution>
diff --git a/src/main/java/org/apache/maven/plugins/buildinfo/BuildInfoWriter.java b/src/main/java/org/apache/maven/plugins/artifact/buildinfo/BuildInfoWriter.java
similarity index 99%
rename from src/main/java/org/apache/maven/plugins/buildinfo/BuildInfoWriter.java
rename to src/main/java/org/apache/maven/plugins/artifact/buildinfo/BuildInfoWriter.java
index 14fc0e1..bc1fe1f 100644
--- a/src/main/java/org/apache/maven/plugins/buildinfo/BuildInfoWriter.java
+++ b/src/main/java/org/apache/maven/plugins/artifact/buildinfo/BuildInfoWriter.java
@@ -1,4 +1,4 @@
-package org.apache.maven.plugins.buildinfo;
+package org.apache.maven.plugins.artifact.buildinfo;
 
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
diff --git a/src/main/java/org/apache/maven/plugins/buildinfo/BuildinfoMojo.java b/src/main/java/org/apache/maven/plugins/artifact/buildinfo/BuildinfoMojo.java
similarity index 99%
rename from src/main/java/org/apache/maven/plugins/buildinfo/BuildinfoMojo.java
rename to src/main/java/org/apache/maven/plugins/artifact/buildinfo/BuildinfoMojo.java
index 2664e31..c01d2bb 100644
--- a/src/main/java/org/apache/maven/plugins/buildinfo/BuildinfoMojo.java
+++ b/src/main/java/org/apache/maven/plugins/artifact/buildinfo/BuildinfoMojo.java
@@ -1,4 +1,4 @@
-package org.apache.maven.plugins.buildinfo;
+package org.apache.maven.plugins.artifact.buildinfo;
 
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
diff --git a/src/main/java/org/apache/maven/plugins/buildinfo/DigestHelper.java b/src/main/java/org/apache/maven/plugins/artifact/buildinfo/DigestHelper.java
similarity index 97%
rename from src/main/java/org/apache/maven/plugins/buildinfo/DigestHelper.java
rename to src/main/java/org/apache/maven/plugins/artifact/buildinfo/DigestHelper.java
index 513674b..2710911 100644
--- a/src/main/java/org/apache/maven/plugins/buildinfo/DigestHelper.java
+++ b/src/main/java/org/apache/maven/plugins/artifact/buildinfo/DigestHelper.java
@@ -1,4 +1,4 @@
-package org.apache.maven.plugins.buildinfo;
+package org.apache.maven.plugins.artifact.buildinfo;
 
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
diff --git a/src/main/java/org/apache/maven/plugins/buildinfo/MavenVersion.java b/src/main/java/org/apache/maven/plugins/artifact/buildinfo/MavenVersion.java
similarity index 98%
rename from src/main/java/org/apache/maven/plugins/buildinfo/MavenVersion.java
rename to src/main/java/org/apache/maven/plugins/artifact/buildinfo/MavenVersion.java
index 8c8df52..88002b3 100644
--- a/src/main/java/org/apache/maven/plugins/buildinfo/MavenVersion.java
+++ b/src/main/java/org/apache/maven/plugins/artifact/buildinfo/MavenVersion.java
@@ -1,4 +1,4 @@
-package org.apache.maven.plugins.buildinfo;
+package org.apache.maven.plugins.artifact.buildinfo;
 
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
diff --git a/src/main/java/org/apache/maven/plugins/buildinfo/ReferenceBuildinfoUtil.java b/src/main/java/org/apache/maven/plugins/artifact/buildinfo/ReferenceBuildinfoUtil.java
similarity index 99%
rename from src/main/java/org/apache/maven/plugins/buildinfo/ReferenceBuildinfoUtil.java
rename to src/main/java/org/apache/maven/plugins/artifact/buildinfo/ReferenceBuildinfoUtil.java
index 15cb8fe..b8477ad 100644
--- a/src/main/java/org/apache/maven/plugins/buildinfo/ReferenceBuildinfoUtil.java
+++ b/src/main/java/org/apache/maven/plugins/artifact/buildinfo/ReferenceBuildinfoUtil.java
@@ -1,4 +1,4 @@
-package org.apache.maven.plugins.buildinfo;
+package org.apache.maven.plugins.artifact.buildinfo;
 
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
diff --git a/src/main/java/org/apache/maven/plugins/buildinfo/SaveMojo.java b/src/main/java/org/apache/maven/plugins/artifact/buildinfo/SaveMojo.java
similarity index 95%
rename from src/main/java/org/apache/maven/plugins/buildinfo/SaveMojo.java
rename to src/main/java/org/apache/maven/plugins/artifact/buildinfo/SaveMojo.java
index a918b19..8a5346e 100644
--- a/src/main/java/org/apache/maven/plugins/buildinfo/SaveMojo.java
+++ b/src/main/java/org/apache/maven/plugins/artifact/buildinfo/SaveMojo.java
@@ -1,4 +1,4 @@
-package org.apache.maven.plugins.buildinfo;
+package org.apache.maven.plugins.artifact.buildinfo;
 
 /*
  * Licensed to the Apache Software Foundation (ASF) under one