tasks

Documentation

Index

• type Task
  • func GitCheckout(ref string, keep bool) Task
  • func GitClone() Task
  • func GitCommit(message string, globs ...string) Task
  • func GitInit() Task
  • func GitNewRef(name string) Task
  • func GitPull(remoteName string) Task
  • func GitRemote(remoteName string) Task
  • func NewFile(path string, content []byte) Task
  • func NewFolder() Task
  • func Sequence(tasks ...Task) Task
  • func SetupRemote() Task

Types

type Task

type Task interface {
	ApplyRepo(r models.Repo) error
	ApplyScratchpad(r models.Scratchpad) error
}

A Task is responsible for performing a specific task on a repository or scratchpad.

func GitCheckout

func GitCheckout(ref string, keep bool) Task

GitCheckout is responsible for checking out a specific branch.

func GitClone

func GitClone() Task

GitClone is responsible for running the equivalent of a `git clone` for a repository.

func GitCommit

func GitCommit(message string, globs ...string) Task

GitCommit is responsible for committing changes within the working directory.

func GitInit

func GitInit() Task

GitInit is responsible for running the equivalent of a `git init` operation for a repository.

func GitNewRef

func GitNewRef(name string) Task

GitNewRef is responsible for creating a new Git reference which points at HEAD.

func GitPull

func GitPull(remoteName string) Task

GitPull is responsible for running the equivalent of a `git pull` operation for the default remote (origin).

func GitRemote

func GitRemote(remoteName string) Task

GitRemote is responsible for running the equivalent of a `git remote add` or `git remote set-url` for a repository.

func NewFile

func NewFile(path string, content []byte) Task

NewFile is responsible for writing a new file.

func NewFolder

func NewFolder() Task

NewFolder is responsible for ensuring that a repository has a valid folder created for it.

func Sequence

func Sequence(tasks ...Task) Task

Sequence will run a series of tasks in sequence. It will stop execution of the sequence on the first error.

func SetupRemote

func SetupRemote() Task

SetupRemote is responsible for creating the upstream repository on whichever service hosts the repo.