com.atlassian.maven.jgitflow.api.example

Class UpdateReadmeExtension

java.lang.Object

com.atlassian.maven.jgitflow.api.impl.NoopMavenReleaseFinishExtension

com.atlassian.maven.jgitflow.api.example.UpdateReadmeExtension

All Implemented Interfaces:

FinishProductionBranchExtension, MavenJGitFlowExtension, MavenReleaseFinishExtension

public class UpdateReadmeExtension
extends NoopMavenReleaseFinishExtension

An example class meant to be used on release-finish to update a README.md file with the new release version

Field Summary

Fields

Modifier and Type	Field and Description
static String	README_MD

Constructor Summary

Constructors

Constructor and Description
UpdateReadmeExtension()

Method Summary

Methods

Modifier and Type	Method and Description
void	onMasterBranchVersionChange(String newVersion, String oldVersion, com.atlassian.jgitflow.core.JGitFlowInfo flow) Updates the README.md file on release-finish with the new release version.

Methods inherited from class com.atlassian.maven.jgitflow.api.impl.NoopMavenReleaseFinishExtension

onTopicBranchVersionChange

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

README_MD

public static final String README_MD

See Also:

Constant Field Values

Constructor Detail

UpdateReadmeExtension

public UpdateReadmeExtension()

Method Detail

onMasterBranchVersionChange

public void onMasterBranchVersionChange(String newVersion,
                               String oldVersion,
                               com.atlassian.jgitflow.core.JGitFlowInfo flow)
                                 throws MavenJGitFlowExtensionException

Updates the README.md file on release-finish with the new release version. Since the change happens on master first and is then back-merged into develop, we only need to change the file when master is updated.

Specified by:

onMasterBranchVersionChange in interface FinishProductionBranchExtension

Overrides:

onMasterBranchVersionChange in class NoopMavenReleaseFinishExtension

Parameters:

newVersion -

oldVersion -

flow -

Throws:

MavenJGitFlowExtensionException