1 package org.apache.maven.shared.release.phase;
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 org.apache.maven.project.MavenProject;
23 import org.apache.maven.shared.release.ReleaseExecutionException;
24 import org.apache.maven.shared.release.ReleaseFailureException;
25 import org.apache.maven.shared.release.ReleaseResult;
26 import org.apache.maven.shared.release.config.ReleaseDescriptor;
27 import org.apache.maven.shared.release.env.ReleaseEnvironment;
28
29 import java.util.List;
30
31 /**
32 * A phase in the release cycle.
33 *
34 * @author <a href="mailto:brett@apache.org">Brett Porter</a>
35 */
36 public interface ReleasePhase
37 {
38 /**
39 * Execute the phase.
40 *
41 * @param releaseDescriptor the configuration to use
42 * @param releaseEnvironment the environmental configuration, such as Maven settings, Maven home, etc.
43 * @param reactorProjects the reactor projects
44 * @throws ReleaseExecutionException an exception during the execution of the phase
45 * @throws ReleaseFailureException a failure during the execution of the phase
46 * @return the release result
47 */
48 ReleaseResult execute( ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment,
49 List<MavenProject> reactorProjects )
50 throws ReleaseExecutionException, ReleaseFailureException;
51
52 /**
53 * Simulate the phase, but don't make any changes to the project.
54 *
55 * @param releaseDescriptor the configuration to use
56 * @param releaseEnvironment the environmental configuration, such as Maven settings, Maven home, etc.
57 * @param reactorProjects the reactor projects
58 * @throws ReleaseExecutionException an exception during the execution of the phase
59 * @throws ReleaseFailureException a failure during the execution of the phase
60 * @return the release result
61 */
62 ReleaseResult simulate( ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment,
63 List<MavenProject> reactorProjects )
64 throws ReleaseExecutionException, ReleaseFailureException;
65
66 }