transaction

type CommitResult interface {
	// GetAuthorName describes the author's name (as per git config)
	// +required
	GetAuthorName() string
	// GetAuthorEmail describes the author's email (as per git config)
	// +required
	GetAuthorEmail() string
	// GetTitle describes the change concisely, so it can be used as a commit message or PR title.
	// +required
	GetTitle() string
	// GetDescription contains optional extra information about the change.
	// +optional
	GetDescription() string

	// GetMessage returns GetTitle() followed by a newline and GetDescription(), if set.
	GetMessage() string
	// Validate validates that all required fields are set, and given data is valid.
	Validate() error
}

type GenericCommitResult struct {
	// AuthorName describes the author's name (as per git config)
	// +required
	AuthorName string
	// AuthorEmail describes the author's email (as per git config)
	// +required
	AuthorEmail string
	// Title describes the change concisely, so it can be used as a commit message or PR title.
	// +required
	Title string
	// Description contains optional extra information about the change.
	// +optional
	Description string
}

type GenericPullRequestResult struct {
	// GenericPullRequestResult is a superset of a CommitResult.
	CommitResult

	// Labels specifies what labels should be applied on the PR.
	// +optional
	Labels []string
	// Assignees specifies what user login names should be assigned to this PR.
	// Note: Only users with "pull" access or more can be assigned.
	// +optional
	Assignees []string
	// Milestone specifies what milestone this should be attached to.
	// +optional
	Milestone string
}

type GenericPullRequestSpec struct {
	// GenericPullRequestSpec is a superset of PullRequestResult.
	PullRequestResult

	// MainBranch returns the main branch of the repository.
	// +required
	MainBranch string
	// MergeBranch returns the branch that is pending to be merged into main with this PR.
	// +required
	MergeBranch string
	// RepositoryRef returns the branch that is pending to be merged into main with this PR.
	// +required
	RepositoryRef gitprovider.RepositoryRef
}

type GitStorage struct {
	storage.ReadStorage
	// contains filtered or unexported fields
}

type PullRequestProvider interface {
	// CreatePullRequest creates a Pull Request using the given specification.
	CreatePullRequest(ctx context.Context, spec PullRequestSpec) error
}

type PullRequestResult interface {
	// PullRequestResult is a superset of CommitResult
	CommitResult

	// GetLabels specifies what labels should be applied on the PR.
	// +optional
	GetLabels() []string
	// GetAssignees specifies what user login names should be assigned to this PR.
	// Note: Only users with "pull" access or more can be assigned.
	// +optional
	GetAssignees() []string
	// GetMilestone specifies what milestone this should be attached to.
	// +optional
	GetMilestone() string
}

type PullRequestSpec interface {
	// PullRequestSpec is a superset of PullRequestResult.
	PullRequestResult

	// GetMainBranch returns the main branch of the repository.
	// +required
	GetMainBranch() string
	// GetMergeBranch returns the branch that is pending to be merged into main with this PR.
	// +required
	GetMergeBranch() string
	// GetMergeBranch returns the branch that is pending to be merged into main with this PR.
	// +required
	GetRepositoryRef() gitprovider.RepositoryRef
}

type TransactionFunc func(ctx context.Context, s storage.Storage) (CommitResult, error)

type TransactionStorage interface {
	storage.ReadStorage

	// Transaction creates a new "stream" (for Git: branch) with the given name, or
	// prefix if streamName ends with a dash (in that case, a 8-char hash will be appended).
	// The environment is made sure to be as up-to-date as possible before fn executes. When
	// fn executes, the given storage can be used to modify the desired state. If you want to
	// "commit" the changes made in fn, just return nil. If you want to abort, return ErrAbortTransaction.
	// If you want to
	Transaction(ctx context.Context, streamName string, fn TransactionFunc) error
}