func push(remote, branch string) error {
task := fmt.Sprintf("Push branch '%v' to remote '%v'", branch, remote)
msg := fmt.Sprintf("Pushing branch '%v' to synchronize", branch)
isCore, err := git.IsCoreBranch(branch)
if err != nil {
return errs.NewError(task, err)
}
if !isCore {
msg += " (using force)"
}
log.Log(msg)
if isCore {
err = git.Push(remote, branch)
} else {
err = git.PushForce(remote, branch)
}
if err != nil {
return errs.NewError(task, err)
}
return nil
}
func runMain() (err error) {
// Load repo config.
gitConfig, err := git.LoadConfig()
if err != nil {
return err
}
var (
remote = gitConfig.RemoteName
trunkBranch = gitConfig.TrunkBranchName
releaseBranch = gitConfig.ReleaseBranchName
stagingBranch = gitConfig.StagingBranchName
)
// Fetch the remote repository.
if !flagNoFetch {
task := "Fetch the remote repository"
log.Run(task)
if err := git.UpdateRemotes(remote); err != nil {
return errs.NewError(task, err)
}
}
// Make sure trunk is up to date.
task := fmt.Sprintf("Make sure that branch '%v' is up to date", trunkBranch)
if err := git.CheckOrCreateTrackingBranch(trunkBranch, remote); err != nil {
return errs.NewError(task, err)
}
// Make sure the staging branch is up to date, in case it exists.
//
// We check stage here as well since it is otherwise checked later
// in releases.ListNewTrunkCommits(), which is usually called in
// release.PromptUserToConfirmStart().
task = fmt.Sprintf("Make sure that branch '%v' is up to date", stagingBranch)
if err := git.CheckOrCreateTrackingBranch(stagingBranch, remote); err != nil {
// The staging branch actually doesn't need to exist.
if _, ok := err.(*git.ErrRefNotFound); !ok {
return errs.NewError(task, err)
}
}
// Make sure that the release branch does not exist.
task = fmt.Sprintf("Make sure that branch '%v' does not exist", releaseBranch)
if err := git.EnsureBranchNotExist(releaseBranch, remote); err != nil {
return errs.NewError(task, err)
}
// Get the current trunk version string.
task = "Get the current trunk version string"
trunkVersion, err := version.GetByBranch(trunkBranch)
if err != nil {
return errs.NewError(task, err)
}
// Get the next trunk version (the future release version).
var nextTrunkVersion *version.Version
if !flagNextTrunk.Zero() {
// Make sure it's only major, minor and patch that are set.
// Make sure the new version is actually incrementing the current one.
var (
current = trunkVersion
next = flagNextTrunk
)
var part string
switch {
case len(next.Pre) != 0:
part = "Pre"
case len(next.Build) != 0:
part = "Build"
}
if part != "" {
return fmt.Errorf("invalid future version string: %v version part cannot be set", part)
}
if current.GE(next.Version) {
return fmt.Errorf("future version string not an increment: %v <= %v", next, current)
}
nextTrunkVersion = &flagNextTrunk
} else {
nextTrunkVersion = trunkVersion.IncrementMinor()
}
// Make sure the next trunk version has the right format.
nextTrunkVersion, err = nextTrunkVersion.ToTrunkVersion()
if err != nil {
return err
}
// Fetch the stories from the issue tracker.
tracker, err := modules.GetIssueTracker()
if err != nil {
return errs.NewError(task, err)
}
release := tracker.NextRelease(trunkVersion, nextTrunkVersion)
// Prompt the user to confirm the release.
fmt.Printf(`
You are about to start a new release branch.
The relevant version strings are:
current release (current trunk version): %v
future release (next trunk version): %v
`, trunkVersion, nextTrunkVersion)
ok, err := release.PromptUserToConfirmStart()
if err != nil {
return err
}
if !ok {
fmt.Println("\nYour wish is my command, exiting now!")
return nil
}
fmt.Println()
// Create the release branch on top of the trunk branch.
task = fmt.Sprintf("Create branch '%v' on top of branch '%v'", releaseBranch, trunkBranch)
log.Run(task)
if err := git.Branch(releaseBranch, trunkBranch); err != nil {
return errs.NewError(task, err)
}
defer action.RollbackTaskOnError(&err, task, action.ActionFunc(func() error {
task := fmt.Sprintf("Delete branch '%v'", releaseBranch)
if err := git.Branch("-D", releaseBranch); err != nil {
errs.NewError(task, err)
}
return nil
}))
// Bump the release branch version.
testingVersion, err := trunkVersion.ToTestingVersion()
if err != nil {
return err
}
task = fmt.Sprintf("Bump version (branch '%v' -> %v)", releaseBranch, testingVersion)
log.Run(task)
_, err = version.SetForBranch(testingVersion, releaseBranch)
if err != nil {
return errs.NewError(task, err)
}
// No need for a rollback function here, git branch -d specified as a rollback
// for the previous step will take care of deleting this change as well.
// Bump the trunk branch version.
task = fmt.Sprintf("Bump version (branch '%v' -> %v)", trunkBranch, nextTrunkVersion)
log.Run(task)
act, err := version.SetForBranch(nextTrunkVersion, trunkBranch)
if err != nil {
return errs.NewError(task, err)
}
defer action.RollbackTaskOnError(&err, task, act)
// Initialise the next release in the code review tool.
codeReviewTool, err := modules.GetCodeReviewTool()
if err != nil {
return err
}
act, err = codeReviewTool.NewRelease(nextTrunkVersion).Initialise()
if err != nil {
return err
}
defer action.RollbackTaskOnError(&err, task, act)
// Start the release in the issue tracker.
act, err = release.Start()
if err != nil {
return err
}
defer action.RollbackTaskOnError(&err, task, act)
// Push the modified branches.
task = "Push changes to the remote repository"
log.Run(task)
err = git.Push(remote, trunkBranch+":"+trunkBranch, releaseBranch+":"+releaseBranch)
if err != nil {
return errs.NewError(task, err)
}
return nil
}
func runMain() error {
// Load config.
config, err := git.LoadConfig()
if err != nil {
return err
}
var (
remoteName = config.RemoteName
trunkName = config.TrunkBranchName
)
// Make sure trunk is up to date.
task := fmt.Sprintf("Make sure branch '%v' is up to date", trunkName)
log.Run(task)
if err := git.CheckOrCreateTrackingBranch(trunkName, remoteName); err != nil {
return errs.NewError(task, err)
}
// Collect the story branches.
task = "Collect the story branches"
log.Run(task)
storyBranches, err := collectStoryBranches(remoteName)
if err != nil {
return errs.NewError(task, err)
}
// Split the branches that are not up to date.
task = "Split the branches that are not up to date"
log.Run(task)
storyBranches, err = splitBranchesNotInSync(storyBranches)
if err != nil {
return errs.NewError(task, err)
}
// Filter branches according to the story state.
task = "Filter branches according to the story state"
log.Run(task)
filteredBranches, err := filterBranches(storyBranches, trunkName)
if err != nil {
return errs.NewError(task, err)
}
if len(storyBranches) == 0 {
log.Log("No branches left to be deleted")
return nil
}
// Prompt the user to choose what branches to delete.
task = "Prompt the user to choose what branches to delete"
localToDelete, remoteToDelete, err := promptUserToChooseBranches(filteredBranches)
if err != nil {
return errs.NewError(task, err)
}
// Delete chosen local branches.
if len(localToDelete) != 0 {
task := "Delete chosen local branches"
log.Run(task)
args := make([]string, 1, 1+len(localToDelete))
args[0] = "-D"
args = append(args, localToDelete...)
if ex := git.Branch(args...); ex != nil {
errs.LogError(task, ex)
err = errors.New("failed to delete local branches")
}
}
// Delete chosen remote branches.
if len(remoteToDelete) != 0 {
task := "Delete chosen remote branches"
log.Run(task)
args := make([]string, 1, 1+len(remoteToDelete))
args[0] = "--delete"
args = append(args, remoteToDelete...)
if ex := git.Push(remoteName, args...); ex != nil {
errs.LogError(task, ex)
err = errors.New("failed to delete remote branches")
}
}
return err
}
func runMain() (err error) {
var (
task string
stderr *bytes.Buffer
)
defer func() {
// Print error details.
if err != nil {
log.FailWithDetails(task, stderr)
}
}()
// Fetch the remote repository unless we are restricted to the local branches only.
if !flagLocalOnly {
task = "Fetch the remote repository"
log.Run(task)
stderr, err = git.UpdateRemotes(config.OriginName)
if err != nil {
return
}
}
// Get the list of story references.
task = "Collect all story branches"
log.Run(task)
localRefs, remoteRefs, stderr, err := git.ListStoryRefs()
if err != nil {
return
}
var refs []string
switch {
case flagLocalOnly:
refs = localRefs
case flagRemoteOnly:
refs = remoteRefs
default:
refs = append(localRefs, remoteRefs...)
}
if len(refs) == 0 {
task = ""
log.Println("\nNo story branches found, exiting...")
return
}
// Collect all the story IDs.
idMap := make(map[string]struct{})
for _, ref := range refs {
// This cannot fail here since we got the refs using ListStoryRefs.
id, _ := git.RefToStoryId(ref)
idMap[id] = struct{}{}
}
var ids []string
for id := range idMap {
ids = append(ids, id)
}
// Get the list of active story IDs.
activeIds, err := modules.GetIssueTracker().SelectActiveStoryIds(ids)
if err != nil {
return
}
ids = activeIds
// Select only the refs that can be safely deleted.
refs = selectInactiveRefs(refs, ids)
if len(refs) == 0 {
task = ""
log.Println("\nThere are no branches to be deleted, exiting...")
return
}
// Sort the refs.
sort.Sort(sort.StringSlice(refs))
// Prompt the user to confirm the delete operation.
var (
toDeleteLocally []string
toDeleteRemotely []string
ok bool
)
// Go through the local branches.
if strings.HasPrefix(refs[0], "refs/heads/") {
fmt.Println("\n---> Local branches\n")
}
for len(refs) > 0 {
ref := refs[0]
if !strings.HasPrefix(ref, "refs/heads/") {
break
}
branch := ref[len("refs/heads/"):]
question := fmt.Sprintf("Delete local branch '%v'", branch)
ok, err = prompt.Confirm(question)
if err != nil {
return
}
if ok {
toDeleteLocally = append(toDeleteLocally, branch)
}
refs = refs[1:]
}
// All that is left are remote branches.
if len(refs) != 0 {
fmt.Println("\n---> Remote branches\n")
}
for _, ref := range refs {
branch := ref[len("refs/remotes/origin/"):]
question := fmt.Sprintf("Delete remote branch '%v'", branch)
ok, err = prompt.Confirm(question)
if err != nil {
return
}
if ok {
toDeleteRemotely = append(toDeleteRemotely, branch)
}
}
fmt.Println()
if len(toDeleteLocally) == 0 && len(toDeleteRemotely) == 0 {
task = ""
fmt.Println("No branches selected, exiting...")
return
}
// Delete the local branches.
if len(toDeleteLocally) != 0 {
task = "Delete the chosen local branches"
log.Run(task)
// Remember the position of the branches to be deleted.
// This is used in case we need to perform a rollback.
var (
currentPositions []string
hexsha string
)
for _, branchName := range toDeleteLocally {
hexsha, stderr, err = git.Hexsha("refs/heads/" + branchName)
if err != nil {
return
}
currentPositions = append(currentPositions, hexsha)
}
// Delete the selected local branches.
args := append([]string{"-d"}, toDeleteLocally...)
stderr, err = git.Branch(args...)
if err != nil {
return
}
defer func(taskMsg string) {
// On error, try to restore the local branches that were deleted.
if err != nil {
log.Rollback(taskMsg)
for i, branchName := range toDeleteLocally {
out, ex := git.ResetKeep(branchName, currentPositions[i])
if ex != nil {
log.FailWithDetails(task, out)
}
}
}
}(task)
}
// Delete the remote branches.
if len(toDeleteRemotely) != 0 {
task = "Delete the chosen remote branches"
log.Run(task)
var refs []string
for _, branchName := range toDeleteRemotely {
refs = append(refs, ":"+branchName)
}
stderr, err = git.Push(config.OriginName, refs...)
}
return
}
func Stage(options *StageOptions) (act action.Action, err error) {
// Rollback machinery.
chain := action.NewActionChain()
defer chain.RollbackOnError(&err)
// Make sure opts are not nil.
if options == nil {
options = DefaultStageOptions
}
// Load git config.
gitConfig, err := git.LoadConfig()
if err != nil {
return nil, err
}
var (
remoteName = gitConfig.RemoteName
releaseBranch = gitConfig.ReleaseBranchName
stagingBranch = gitConfig.StagingBranchName
)
// Instantiate the issue tracker.
tracker, err := modules.GetIssueTracker()
if err != nil {
return nil, err
}
// Get the current branch.
task := "Get the current branch"
currentBranch, err := gitutil.CurrentBranch()
if err != nil {
return nil, err
}
// Cannot be on the release branch, it will be deleted.
task = fmt.Sprintf("Make sure that branch '%v' is not checked out", releaseBranch)
if currentBranch == releaseBranch {
return nil, errs.NewError(
task, fmt.Errorf("cannot stage the release while on branch '%v'", releaseBranch))
}
// Fetch the remote repository.
if !options.SkipFetch {
task = "Fetch the remote repository"
log.Run(task)
if err := git.UpdateRemotes(remoteName); err != nil {
return nil, errs.NewError(task, err)
}
}
// Make sure that the local release branch exists and is up to date.
task = fmt.Sprintf("Make sure that branch '%v' is up to date", releaseBranch)
log.Run(task)
if err := git.CheckOrCreateTrackingBranch(releaseBranch, remoteName); err != nil {
return nil, errs.NewError(task, err)
}
// Read the current release version.
task = "Read the current release version"
releaseVersion, err := version.GetByBranch(releaseBranch)
if err != nil {
return nil, errs.NewError(task, err)
}
// Make sure the release is stageable.
release := tracker.RunningRelease(releaseVersion)
if err := release.EnsureStageable(); err != nil {
return nil, err
}
// Make sure there are no commits being left behind,
// e.g. make sure no commits are forgotten on the trunk branch,
// i.e. make sure that everything necessary was cherry-picked.
if err := checkCommits(tracker, release, releaseBranch); err != nil {
return nil, err
}
// Reset the staging branch to point to the newly created tag.
task = fmt.Sprintf("Reset branch '%v' to point to branch '%v'", stagingBranch, releaseBranch)
log.Run(task)
act, err = git.CreateOrResetBranch(stagingBranch, releaseBranch)
if err != nil {
return nil, errs.NewError(task, err)
}
chain.PushTask(task, act)
// Delete the local release branch.
task = fmt.Sprintf("Delete branch '%v'", releaseBranch)
log.Run(task)
if err := git.Branch("-D", releaseBranch); err != nil {
return nil, errs.NewError(task, err)
}
chain.PushTask(task, action.ActionFunc(func() error {
task := fmt.Sprintf("Recreate branch '%v'", releaseBranch)
// In case the release branch exists locally, do nothing.
// This might look like an extra and useless check, but it looks like
// the final git push at the end of the command function actually creates
// the release branch locally when it is aborted from the pre-push hook.
// Not sure why and how that is happening.
exists, err := git.LocalBranchExists(releaseBranch)
if err != nil {
return errs.NewError(task, err)
}
if exists {
return nil
}
// In case the branch indeed does not exist, create it.
if err := git.Branch(releaseBranch, remoteName+"/"+releaseBranch); err != nil {
return errs.NewError(task, err)
}
return nil
}))
// Update the version string on the staging branch.
stagingVersion, err := releaseVersion.ToStageVersion()
if err != nil {
return nil, err
}
task = fmt.Sprintf("Bump version (branch '%v' -> %v)", stagingBranch, stagingVersion)
log.Run(task)
act, err = version.SetForBranch(stagingVersion, stagingBranch)
if err != nil {
return nil, errs.NewError(task, err)
}
chain.PushTask(task, act)
// Stage the release in the issue tracker.
act, err = release.Stage()
if err != nil {
return nil, err
}
chain.Push(act)
// Push to create the tag, reset client and delete release in the remote repository.
task = "Push changes to the remote repository"
log.Run(task)
err = git.Push(remoteName,
"-f", // Use the Force, Luke.
":"+releaseBranch, // Delete the release branch.
stagingBranch+":"+stagingBranch) // Push the staging branch.
if err != nil {
return nil, err
}
return chain, nil
}
func createBranch() (action.Action, error) {
// Get the current branch name.
originalBranch, err := gitutil.CurrentBranch()
if err != nil {
return nil, err
}
// Fetch the remote repository.
task := "Fetch the remote repository"
log.Run(task)
gitConfig, err := git.LoadConfig()
if err != nil {
return nil, errs.NewError(task, err)
}
var (
remoteName = gitConfig.RemoteName
baseBranch = gitConfig.TrunkBranchName
)
if flagBase != "" {
baseBranch = flagBase
}
// Fetch the remote repository.
if err := git.UpdateRemotes(remoteName); err != nil {
return nil, errs.NewError(task, err)
}
// Make sure the trunk branch is up to date.
task = fmt.Sprintf("Make sure branch '%v' is up to date", baseBranch)
log.Run(task)
if err := git.CheckOrCreateTrackingBranch(baseBranch, remoteName); err != nil {
return nil, errs.NewError(task, err)
}
// Prompt the user for the branch name.
task = "Prompt the user for the branch name"
line, err := prompt.Prompt(`
Please insert the branch slug now.
Insert an empty string to skip the branch creation step: `)
if err != nil && err != prompt.ErrCanceled {
return nil, errs.NewError(task, err)
}
sluggedLine := slug.Slug(line)
if sluggedLine == "" {
fmt.Println()
log.Log("Not creating any feature branch")
return nil, nil
}
branchName := "story/" + sluggedLine
ok, err := prompt.Confirm(
fmt.Sprintf(
"\nThe branch that is going to be created will be called '%s'.\nIs that alright?",
branchName),
true)
if err != nil {
return nil, errs.NewError(task, err)
}
if !ok {
panic(prompt.ErrCanceled)
}
fmt.Println()
createTask := fmt.Sprintf(
"Create branch '%v' on top of branch '%v'", branchName, baseBranch)
log.Run(createTask)
if err := git.Branch(branchName, baseBranch); err != nil {
return nil, errs.NewError(createTask, err)
}
deleteTask := fmt.Sprintf("Delete branch '%v'", branchName)
deleteBranch := func() error {
// Roll back and delete the newly created branch.
log.Rollback(createTask)
if err := git.Branch("-D", branchName); err != nil {
return errs.NewError(deleteTask, err)
}
return nil
}
// Checkout the newly created branch.
checkoutTask := fmt.Sprintf("Checkout branch '%v'", branchName)
log.Run(checkoutTask)
if err := git.Checkout(branchName); err != nil {
if err := deleteBranch(); err != nil {
errs.Log(err)
}
return nil, errs.NewError(checkoutTask, err)
}
// Push the newly created branch unless -no_push.
pushTask := fmt.Sprintf("Push branch '%v' to remote '%v'", branchName, remoteName)
if flagPush {
log.Run(pushTask)
if err := git.Push(remoteName, branchName); err != nil {
if err := deleteBranch(); err != nil {
errs.Log(err)
}
return nil, errs.NewError(pushTask, err)
}
}
return action.ActionFunc(func() error {
// Checkout the original branch.
log.Rollback(checkoutTask)
if err := git.Checkout(originalBranch); err != nil {
return errs.NewError(
fmt.Sprintf("Checkout the original branch '%v'", originalBranch), err)
}
// Delete the newly created branch.
deleteErr := deleteBranch()
// In case we haven't pushed anything, we are done.
if !flagPush {
return deleteErr
}
// Delete the branch from the remote repository.
log.Rollback(pushTask)
if _, err := git.Run("push", "--delete", remoteName, branchName); err != nil {
// In case deleteBranch failed, tell the user now
// since we are not going to return that error.
if deleteErr != nil {
errs.Log(deleteErr)
}
return errs.NewError(
fmt.Sprintf("Delete branch '%v' from remote '%v'", branchName, remoteName), err)
}
// Return deleteErr to make sure it propagates up.
return deleteErr
}), nil
}
func Init(force bool) error {
// Check whether the repository has been initialised yet.
task := "Check whether the repository has been initialised"
versionString, err := git.GetConfigString("salsaflow.initialised")
if err != nil {
return errs.NewError(task, err)
}
if versionString == metadata.Version && !force {
return errs.NewError(task, ErrInitialised)
}
log.Log("Initialising the repository for SalsaFlow")
// Make sure the user is using the right version of Git.
//
// The check is here and not in app.Init because it is highly improbable
// that the check would pass once and then fail later. Once the right
// version of git is installed, it most probably stays.
task = "Check the git version being used"
log.Run(task)
stdout, err := git.Run("--version")
if err != nil {
return errs.NewError(task, err)
}
pattern := regexp.MustCompile("^git version (([0-9]+)[.]([0-9]+).*)")
parts := pattern.FindStringSubmatch(stdout.String())
if len(parts) != 4 {
return errs.NewError(task, errors.New("unexpected git --version output"))
}
gitVersion := parts[1]
// This cannot fail since we matched the regexp.
major, _ := strconv.Atoi(parts[2])
minor, _ := strconv.Atoi(parts[3])
// We need Git version 1.8.5.4+, so let's require 1.9+.
switch {
case major >= 2:
// OK
case major == 1 && minor >= 9:
// OK
default:
hint := `
You need Git version 1.9.0 or newer.
`
return errs.NewErrorWithHint(
task,
errors.New("unsupported git version detected: "+gitVersion),
hint)
}
// Get hold of a git config instance.
gitConfig, err := git.LoadConfig()
if err != nil {
return err
}
var (
remoteName = gitConfig.RemoteName
trunkBranch = gitConfig.TrunkBranchName
stableBranch = gitConfig.StableBranchName
)
// Make sure that the stable branch exists.
task = fmt.Sprintf("Make sure branch '%v' exists", stableBranch)
log.Run(task)
err = git.CheckOrCreateTrackingBranch(stableBranch, remoteName)
if err != nil {
if ex, ok := err.(*git.ErrRefNotFound); ok {
hint := fmt.Sprintf(
"Make sure that branch '%v' exists and run init again.\n", ex.Ref)
return errs.NewErrorWithHint(task, err, hint)
} else if _, ok := err.(*git.ErrRefNotInSync); !ok {
// We ignore ErrRefNotInSync here, so return the error
// in case it is of some other kind.
return errs.NewError(task, err)
}
}
// Make sure that the trunk branch exists.
task = fmt.Sprintf("Make sure branch '%v' exists", trunkBranch)
log.Run(task)
err = git.CheckOrCreateTrackingBranch(trunkBranch, remoteName)
if err != nil {
if _, ok := err.(*git.ErrRefNotFound); ok {
task := fmt.Sprintf("Create branch '%v'", trunkBranch)
log.Log(fmt.Sprintf(
"Branch '%v' not found. Will create one for you for free!", trunkBranch))
if err := git.Branch(trunkBranch, stableBranch); err != nil {
return errs.NewError(task, err)
}
log.NewLine(fmt.Sprintf(
"The newly created branch is pointing to '%v'.", stableBranch))
task = fmt.Sprintf("Push branch '%v' to remote '%v'", trunkBranch, remoteName)
log.Run(task)
if err := git.Push(remoteName, trunkBranch+":"+trunkBranch); err != nil {
return errs.NewError(task, err)
}
} else if _, ok := err.(*git.ErrRefNotInSync); !ok {
// We ignore ErrRefNotInSync here, so return the error
// in case it is of some other kind.
return errs.NewError(task, err)
}
}
// Verify our git hooks are installed and used.
for _, kind := range hooks.HookTypes {
task := fmt.Sprintf("Check the current git %v hook", kind)
log.Run(task)
if err := hooks.CheckAndUpsert(kind, force); err != nil {
return errs.NewError(task, err)
}
}
// Run other registered init hooks.
task = "Running the registered repository init hooks"
log.Log(task)
if err := executeInitHooks(); err != nil {
return errs.NewError(task, err)
}
// Success! Mark the repository as initialised in git config.
task = "Mark the repository as initialised"
if err := git.SetConfigString("salsaflow.initialised", metadata.Version); err != nil {
return err
}
asciiart.PrintThumbsUp()
fmt.Println()
log.Log("The repository is initialised")
return nil
}