Class AbstractScmCommitPhase
- java.lang.Object
-
- org.codehaus.plexus.logging.AbstractLogEnabled
-
- org.apache.maven.shared.release.phase.AbstractReleasePhase
-
- org.apache.maven.shared.release.phase.AbstractScmCommitPhase
-
- All Implemented Interfaces:
ReleasePhase
,org.codehaus.plexus.logging.LogEnabled
- Direct Known Subclasses:
ScmCommitDevelopmentPhase
,ScmCommitPreparationPhase
public abstract class AbstractScmCommitPhase extends AbstractReleasePhase
Holds the basic concept of committing changes to the current working copy.
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
afterBranchOrTag
protected boolean
beforeBranchOrTag
protected java.lang.String
descriptorCommentGetter
The getter in the descriptor for the comment.protected ScmRepositoryConfigurator
scmRepositoryConfigurator
Tool that gets a configured SCM repository from release configuration.
-
Constructor Summary
Constructors Constructor Description AbstractScmCommitPhase()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description private void
checkin(org.apache.maven.scm.provider.ScmProvider provider, org.apache.maven.scm.repository.ScmRepository repository, org.apache.maven.scm.ScmFileSet fileSet, ReleaseDescriptor releaseDescriptor, java.lang.String message)
protected java.lang.String
createMessage(java.util.List<org.apache.maven.project.MavenProject> reactorProjects, ReleaseDescriptor releaseDescriptor)
protected static java.util.List<java.io.File>
createPomFiles(ReleaseDescriptor releaseDescriptor, java.util.List<org.apache.maven.project.MavenProject> reactorProjects)
protected static java.util.List<java.io.File>
createPomFiles(ReleaseDescriptor releaseDescriptor, org.apache.maven.project.MavenProject project)
ReleaseResult
execute(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, java.util.List<org.apache.maven.project.MavenProject> reactorProjects)
Execute the phase.protected void
performCheckins(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, java.util.List<org.apache.maven.project.MavenProject> reactorProjects, java.lang.String message)
protected abstract void
runLogic(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, java.util.List<org.apache.maven.project.MavenProject> reactorProjects, ReleaseResult result, boolean simulating)
ReleaseResult
simulate(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, java.util.List<org.apache.maven.project.MavenProject> reactorProjects)
Simulate the phase, but don't make any changes to the project.protected void
simulateCheckins(ReleaseDescriptor releaseDescriptor, java.util.List<org.apache.maven.project.MavenProject> reactorProjects, ReleaseResult result, java.lang.String message)
protected void
validateConfiguration(ReleaseDescriptor releaseDescriptor)
-
Methods inherited from class org.apache.maven.shared.release.phase.AbstractReleasePhase
getReleaseResultSuccess, logDebug, logDebug, logError, logInfo, logWarn
-
-
-
-
Field Detail
-
beforeBranchOrTag
protected boolean beforeBranchOrTag
-
afterBranchOrTag
protected boolean afterBranchOrTag
-
scmRepositoryConfigurator
protected ScmRepositoryConfigurator scmRepositoryConfigurator
Tool that gets a configured SCM repository from release configuration.
-
descriptorCommentGetter
protected java.lang.String descriptorCommentGetter
The getter in the descriptor for the comment.
-
-
Method Detail
-
execute
public ReleaseResult execute(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, java.util.List<org.apache.maven.project.MavenProject> reactorProjects) throws ReleaseExecutionException, ReleaseFailureException
Description copied from interface:ReleasePhase
Execute the phase.- Parameters:
releaseDescriptor
- the configuration to usereleaseEnvironment
- the environmental configuration, such as Maven settings, Maven home, etc.reactorProjects
- the reactor projects- Returns:
- the release result
- Throws:
ReleaseExecutionException
- an exception during the execution of the phaseReleaseFailureException
- a failure during the execution of the phase
-
simulate
public ReleaseResult simulate(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, java.util.List<org.apache.maven.project.MavenProject> reactorProjects) throws ReleaseExecutionException, ReleaseFailureException
Description copied from interface:ReleasePhase
Simulate the phase, but don't make any changes to the project.- Parameters:
releaseDescriptor
- the configuration to usereleaseEnvironment
- the environmental configuration, such as Maven settings, Maven home, etc.reactorProjects
- the reactor projects- Returns:
- the release result
- Throws:
ReleaseExecutionException
- an exception during the execution of the phaseReleaseFailureException
- a failure during the execution of the phase
-
runLogic
protected abstract void runLogic(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, java.util.List<org.apache.maven.project.MavenProject> reactorProjects, ReleaseResult result, boolean simulating) throws ReleaseScmCommandException, ReleaseExecutionException, ReleaseScmRepositoryException
-
performCheckins
protected void performCheckins(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, java.util.List<org.apache.maven.project.MavenProject> reactorProjects, java.lang.String message) throws ReleaseScmRepositoryException, ReleaseExecutionException, ReleaseScmCommandException
-
checkin
private void checkin(org.apache.maven.scm.provider.ScmProvider provider, org.apache.maven.scm.repository.ScmRepository repository, org.apache.maven.scm.ScmFileSet fileSet, ReleaseDescriptor releaseDescriptor, java.lang.String message) throws ReleaseExecutionException, ReleaseScmCommandException
-
simulateCheckins
protected void simulateCheckins(ReleaseDescriptor releaseDescriptor, java.util.List<org.apache.maven.project.MavenProject> reactorProjects, ReleaseResult result, java.lang.String message)
-
validateConfiguration
protected void validateConfiguration(ReleaseDescriptor releaseDescriptor) throws ReleaseFailureException
- Throws:
ReleaseFailureException
-
createMessage
protected java.lang.String createMessage(java.util.List<org.apache.maven.project.MavenProject> reactorProjects, ReleaseDescriptor releaseDescriptor) throws ReleaseExecutionException
- Throws:
ReleaseExecutionException
-
createPomFiles
protected static java.util.List<java.io.File> createPomFiles(ReleaseDescriptor releaseDescriptor, org.apache.maven.project.MavenProject project)
-
createPomFiles
protected static java.util.List<java.io.File> createPomFiles(ReleaseDescriptor releaseDescriptor, java.util.List<org.apache.maven.project.MavenProject> reactorProjects)
-
-