repo

Documentation

Index

• type Repo
  • func (r *Repo) Commands() []string
  • func (r *Repo) IsGit() bool
  • func (r *Repo) IsLocal() bool
  • func (r *Repo) IsRemote() bool

Types

type Repo

type Repo struct {
	// The name of the Repository. This should be the
	// canonical name, for example, github.com/drone/drone.
	Name string

	// The path of the Repoisotry. This could be
	// the remote path of a Git repository or the path of
	// of the repository on the local file system.
	//
	// A remote path must start with http://, https://,
	// git://, ssh:// or git@. Otherwise we'll assume
	// the repository is located on the local filesystem.
	Path string

	// (optional) Specific Branch that we should checkout
	// when the Repository is cloned. If no value is
	// provided we'll assume the default, master branch.
	Branch string

	// (optional) Specific Commit Hash that we should
	// checkout when the Repository is cloned. If no
	// value is provided we'll assume HEAD.
	Commit string

	// (optional) Pull Request number that we should
	// checkout when the Repository is cloned.
	PR string

	// (optional) The filesystem path that the repository
	// will be cloned into (or copied to) inside the
	// host system (Docker Container).
	Dir string

	// (optional) The depth of the `git clone` command.
	Depth int
}

func (*Repo) Commands

func (r *Repo) Commands() []string

returns commands that can be used in a Dockerfile to clone the repository.

TODO we should also enable Mercurial projects and SVN projects

func (*Repo) IsGit

func (r *Repo) IsGit() bool

IsGit returns true if the Repository is a Git repoisitory.

func (*Repo) IsLocal

func (r *Repo) IsLocal() bool

IsLocal returns true if the Repository is located on the local filesystem.

func (*Repo) IsRemote

func (r *Repo) IsRemote() bool

IsRemote returns true if the Repository is located on a remote server (ie Github, Bitbucket)