package
7.2.0+incompatible
Repository: https://github.com/jimzhan/git-town.git
Documentation: pkg.go.dev

# Functions

DeletePreviousRunState deletes the previous run state from disk.
GetSyncBranchSteps returns the steps to sync the branch with the given name.
LoadPreviousRunState loads the run state from disk if it exists or creates a new run state.
NewRunState returns a new run state.
Run runs the Git Town command described by the given state nolint: gocyclo.
SaveRunState saves the run state to disk.

# Structs

AbortMergeBranchStep aborts the current merge conflict.
AbortRebaseBranchStep represents aborting on ongoing merge conflict.
AddToPerennialBranches adds the branch with the given name as a perennial branch.
ChangeDirectoryStep changes the current working directory.
CheckoutBranchStep checks out a new branch.
CommitOpenChangesStep commits all open changes as a new commit.
ContinueMergeBranchStep finishes an ongoing merge conflict assuming all conflicts have been resolved by the user.
ContinueRebaseBranchStep finishes an ongoing rebase operation assuming all conflicts have been resolved by the user.
CreateBranchStep creates a new branch but leaves the current branch unchanged.
CreatePullRequestStep creates a new pull request for the current branch.
CreateRemoteBranchStep pushes the current branch up to origin.
CreateTrackingBranchStep pushes the current branch up to origin and marks it as tracking the current branch.
DeleteLocalBranchStep deletes the branch with the given name, optionally in a safe or unsafe way.
DeleteParentBranchStep removes the parent branch entry in the Git Town configuration.
DeleteRemoteBranchStep deletes the current branch from the origin remote.
DiscardOpenChangesStep resets the branch to the last commit, discarding uncommitted changes.
DriverMergePullRequestStep squash merges the branch with the given name into the current branch.
EnsureHasShippableChangesStep asserts that the branch has unique changes not on the main branch.
FetchUpstreamStep brings the Git history of the local repository up to speed with activities that happened in the upstream remote.
JSONStep is used to store a step in JSON.
MergeBranchStep merges the branch with the given name into the current branch.
NoOpStep does nothing.
PreserveCheckoutHistoryStep does stuff.
PullBranchStep pulls the branch with the given name from the origin remote.
PushBranchAfterCurrentBranchSteps is a mock step that is used in the undo process to push the branch after other steps have been undone.
PushBranchStep pushes the branch with the given name to the origin remote.
PushTagsStep pushes newly created Git tags to the remote.
RebaseBranchStep rebases the current branch against the branch with the given name.
RemoveFromPerennialBranches removes the branch with the given name as a perennial branch.
ResetToShaStep undoes all commits on the current branch all the way until the given SHA.
RestoreOpenChangesStep restores stashed away changes into the workspace.
RevertCommitStep reverts the commit with the given sha.
RunState represents the current state of a Git Town command, including which operations are left to do, and how to undo what has ben done so far.
SetParentBranchStep registers the branch with the given name as a parent of the branch with the other given name.
SkipCurrentBranchSteps is a mock step to be used instead of running another list of steps.
SquashMergeBranchStep squash merges the branch with the given name into the current branch.
StashOpenChangesStep stores all uncommitted changes on the Git stash.
StepList is a list of steps with convenience functions for adding and removing steps.
UnfinishedRunStateDetails has details about an unfinished run state.
WrapOptions represents the options given to Wrap.

# Interfaces

Step represents a dedicated activity within a Git Town command.