View Javadoc
1   package org.apache.maven.plugins.artifact.buildinfo;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.util.Map;
23  
24  import org.apache.maven.artifact.Artifact;
25  import org.apache.maven.plugin.MojoExecutionException;
26  import org.apache.maven.plugins.annotations.Component;
27  import org.apache.maven.plugins.annotations.LifecyclePhase;
28  import org.apache.maven.plugins.annotations.Mojo;
29  import org.apache.maven.plugins.annotations.Parameter;
30  import org.apache.maven.project.MavenProjectHelper;
31  
32  /**
33   * Creates a buildinfo file recording build environment and output, as specified in
34   * <a href="https://reproducible-builds.org/docs/jvm/">Reproducible Builds for the JVM</a>
35   * for mono-module build, and extended for multi-module build.
36   */
37  @Mojo( name = "buildinfo", defaultPhase = LifecyclePhase.VERIFY )
38  public class BuildinfoMojo
39      extends AbstractBuildinfoMojo
40  {
41      /**
42       * Specifies whether to attach the generated buildinfo file to the project.
43       */
44      @Parameter( property = "buildinfo.attach", defaultValue = "true" )
45      private boolean attach;
46  
47      /**
48       * Used for attaching the buildinfo file in the project.
49       */
50      @Component
51      private MavenProjectHelper projectHelper;
52  
53      @Override
54      public void execute( Map<Artifact, String> artifacts )
55          throws MojoExecutionException
56      {
57          // eventually attach
58          if ( attach )
59          {
60              getLog().info( "Attaching buildinfo" );
61              projectHelper.attachArtifact( project, "buildinfo", buildinfoFile );
62          }
63          else
64          {
65              getLog().info( "NOT adding buildinfo to the list of attached artifacts." );
66          }
67      }
68  }