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