models

type Plan struct {
	// Project is the project this plan is for.
	Project Project
	// LocalPath is the absolute path to the plan on disk
	// (versus the relative path from the repo root).
	LocalPath string
}

type Project struct {
	// RepoFullName is the owner and repo name, ex. "hootsuite/atlantis"
	RepoFullName string
	// Path to project root in the repo.
	// If "." then project is at root.
	// Never ends in "/".
	Path string
}

type ProjectLock struct {
	// Project is the project that is being locked.
	Project Project
	// Pull is the pull request from which the command was run that
	// created this lock.
	Pull PullRequest
	// User is the GitHub username of the user that ran the command
	// that created this lock.
	User User
	// Env is the Terraform environment that this
	// lock is being held against.
	Env string
	// Time is the time at which the lock was first created.
	Time time.Time
}

type PullRequest struct {
	// Num is the pull request number or ID.
	Num int
	// HeadCommit points to the head of the branch that is being
	// pull requested into the base.
	HeadCommit string
	// BaseCommit points to the head of the branch that this
	// pull request will be merged into.
	BaseCommit string
	// URL is the url of the pull request.
	// ex. "https://github.com/hootsuite/atlantis/pull/1"
	URL string
	// Branch is the name of the head branch (not the base).
	Branch string
	// Author is the GitHub username of the pull request author.
	Author string
}

type Repo struct {
	// FullName is the owner and repo name separated
	// by a "/", ex. "hootsuite/atlantis".
	FullName string
	// Owner is just the repo owner, ex. "hootsuite".
	Owner string
	// Name is just the repo name, ex. "atlantis".
	Name string
	// CloneURL is the full HTTPS url for cloning with username and token string
	// ex. "https://username:token@github.com/atlantis/atlantis.git".
	CloneURL string
	// SanitizedCloneURL is the full HTTPS url for cloning without the username and password.
	// ex. "https://github.com/atlantis/atlantis.git".
	SanitizedCloneURL string
}

type User struct {
	Username string
}