com.dkirrane.gitflow.groovy.GitflowFeature.groovy Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ggitflow Show documentation
Show all versions of ggitflow Show documentation
Uploads all artifacts belonging to configuration ':archives'
/*
* Copyright (C) 2014 Desmond Kirrane
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see ")
}
if(!init.gitflowIsInitialized()){
init.cmdDefault()
}
def prefix = init.getFeatureBranchPrefix()
if(featureBranchName.contains(prefix)){
featureBranchName = featureBranchName.minus(prefix)
}
def featureBranch = prefix + featureBranchName
// require_base_is_on_develop
def develop = init.getDevelopBranch()
def master = init.getMasterBranch()
if(startCommit) {
def scOnDevelop = init.gitIsBranchMergedInto(startCommit,develop)
if(!scOnDevelop){
throw new GitflowException("Given start commit '${startCommit}' is not a valid commit on '${develop}'.")
}
} else {
startCommit = develop
}
// sanity checks
if(init.gitBranchExists(featureBranch)){
throw new GitflowException("ERROR: feature branch ${featureBranch} already exists")
}
// update the local repo with remote changes, if asked
def origin = init.getOrigin()
if(origin){
// if the origin branch counterpart exists, fetch and assert that
// the local branch isn't behind it (to avoid unnecessary rebasing)
init.executeRemote("git fetch --all")
if(init.gitBranchExists("${origin}/${develop}")){
init.requireBranchesEqual(develop, "${origin}/${develop}")
}
}
// create branch
def cmd = "git checkout -b ${featureBranch} ${develop}"
init.executeLocal(cmd)
// push it
if(push && origin) {
Integer exitCode = init.executeRemote("git push ${origin} ${featureBranch}")
if(exitCode){
def errorMsg
if (System.properties['os.name'].toLowerCase().contains("windows")) {
errorMsg = "Issue pushing feature branch '${featureBranch}' to '${origin}'. Please ensure your username and password is in your ~/_netrc file"
} else {
errorMsg = "Issue pushing feature branch '${featureBranch}' to '${origin}'. Please ensure your username and password is in your ~/.netrc file"
}
throw new GitflowException(errorMsg)
}
}
log.info ""
log.info "Summary of actions:"
log.info "- A new branch '${featureBranch}' was created, based on '${init.getDevelopBranch()}'"
log.info "- You are now on branch '${featureBranch}'"
log.info ""
log.info "Now, start committing on your feature. When done, use:"
log.info ""
log.info " mvn ggitflow:feature-finish"
log.info ""
}
void finish(String featureBranchName) throws GitflowException, GitflowMergeConflictException {
init.requireGitRepo()
if(!featureBranchName) {
throw new GitflowException("Missing argument ")
}
if(!init.gitflowIsInitialized()){
throw new GitflowException("Gitflow is not initialized.")
}
msgPrefix = msgPrefix ? msgPrefix + " " : ""
msgSuffix = msgSuffix ? " " + msgSuffix : ""
def prefix = init.getFeatureBranchPrefix()
if(featureBranchName.contains(prefix)){
featureBranchName = featureBranchName.minus(prefix)
}
def featureBranch = prefix + featureBranchName
// sanity checks
if(!init.gitBranchExists(featureBranch)){
throw new GitflowException("Feature branch " + featureBranch + " does not exist")
}
// detect if we're restoring from a merge conflict
File mergeBaseFile = new File(init.repoDir, ".git" + File.separator + ".gitflow" + File.separator + "MERGE_BASE")
String mergeBasePath = mergeBaseFile.getCanonicalPath()
if(mergeBaseFile.exists()) {
if(init.gitIsCleanWorkingTree()){
def finishBase = init.executeLocal("cat ${mergeBasePath}")
// Since the working tree is now clean, either the user did a
// succesfull merge manually, or the merge was cancelled.
// We detect this using git_is_branch_merged_into()
if(init.gitIsBranchMergedInto(featureBranch, finishBase)) {
init.executeLocal("rm -f ${mergeBasePath}")
helperFinishCleanup()
System.exit(0)
} else {
// If the user cancelled the merge and decided to wait until later,
// that's fine. But we have to acknowledge this by removing the
// MERGE_BASE file and continuing normal execution of the finish
mergeBaseFile.delete()
}
} else {
log.warn ""
log.warn "Merge conflicts not resolved yet, use:"
log.warn " git mergetool"
log.warn " git commit"
log.warn ""
log.warn "You can then complete the finish by running feature finish again"
log.warn ""
// System.exit(1)
}
}
if(!init.gitIsCleanWorkingTree()){
throw new GitflowException("Failed to finish. Need a clean working tree")
}
// update local repo with remote changes
def origin = init.getOrigin()
def develop = init.getDevelopBranch()
if(origin){
// if the origin branch counterpart exists, fetch and assert that
// the local branch isn't behind it (to avoid unnecessary rebasing)
init.executeRemote("git fetch --all")
if(init.gitBranchExists("${origin}/${featureBranch}")){
init.requireBranchesEqual(featureBranch, "${origin}/${featureBranch}")
}
if(init.gitBranchExists("${origin}/${develop}")){
init.requireBranchesEqual(develop, "${origin}/${develop}")
}
}
// if the user wants to rebase, do that first
if(isRebase) {
this.rebase(featureBranch)
}
// merge into BASE
init.executeLocal("git checkout ${develop}")
def commits = []
def process = "git rev-list -n2 ${develop}..${featureBranch}".execute(null, init.repoDir)
process.in.eachLine { line -> commits.add(line) }
def msg = "${msgPrefix}Merge branch '${featureBranch}' into ${develop}${msgSuffix}"
if(commits.size() == 1) {
init.executeLocal(["git", "merge", "-m", "\"${msg}\"", "--ff", "${featureBranch}"])
} else {
if(!squash){
init.executeLocal(["git", "merge", "-m", "\"${msg}\"", "--no-ff", "${featureBranch}"])
} else {
def squashMsg = "${msgPrefix}Squashing branch '${featureBranch}' into ${develop}${msgSuffix}"
init.executeLocal("git merge --squash ${featureBranch}")
init.executeLocal(["git", "commit", "-m", "\"${squashMsg}\""])
init.executeLocal(["git", "merge", "-m", "\"${msg}\"", "${featureBranch}"])
}
}
// we have a merge conflict
// when no merge conflict is detected, just clean up the feature branch
this.helperFinishCleanup(featureBranch)
}
private void rebase(String featureBranchName) {
init.requireCleanWorkingTree()
init.requireBranch(featureBranchName)
init.executeLocal("git checkout -q ${featureBranchName}")
def opts
if(isInteractive){
opts = "-i"
}
def develop = init.getDevelopBranch()
Integer rebaseExitCode
if(opts) {
rebaseExitCode = init.executeRemote("git rebase ${opts} ${develop}")
} else {
rebaseExitCode = init.executeRemote("git rebase ${develop}")
}
if(rebaseExitCode != 0){
log.warn "WARN: Finish was aborted due to conflicts during rebase."
log.warn "WARN: Please finish the rebase manually now."
log.warn "WARN: When finished, re-run:"
log.warn "WARN: mvn ggitflow:feature-finish"
throw new GitflowException("Rebase feature onto develop has conflicts")
} else {
log.debug "Rebase complete"
}
}
private void helperFinishCleanup(String featureBranchName) {
init.requireBranch(featureBranchName)
init.requireCleanWorkingTree()
// delete branch
def origin = init.getOrigin()
if(push && origin && !keep){
init.executeRemote("git push ${origin} :refs/heads/${featureBranchName}")
}
if (!keep) {
init.executeLocal("git branch -d ${featureBranchName}")
}
log.info ""
log.info "Summary of actions:"
log.info "- The feature branch '${featureBranchName}' was merged into '${developBranch}'"
log.info "- You are now on branch '${developBranch}'"
log.info ""
}
}