workflow_helpers

Documentation

Index

• Constants
• Variables
• func ActiveVersionsOnBranch(ghClient *github.Client, jiraClient *jira.Client, branchName string, ...) ([]semver.Version, error)
• func BranchHasVersionsGT(client *github.Client, jiraClient *jira.Client, branchName string, ...) (bool, error)
• func CreateBranch(ghClient *github.Client, branchName string, SHA string) error
• func CreateFileUpdateCommit(ghClient *github.Client, branchName string, path string, contents string, ...) (string, error)
• func CreatePR(ghClient *github.Client, prName, branchName, baseBranch, body string) (*github.PullRequest, error)
• func ExtractJiraIssueID(pr *github.PullRequest) (string, error)
• func FetchCommitsByRef(ghClient *github.Client, ref string, ...) ([]*github.RepositoryCommit, error)
• func FetchCommitsByShaRange(ghClient *github.Client, startSha string, stopSha string) ([]*github.RepositoryCommit, error)
• func FetchJiraIDsInCommits(commits []*github.RepositoryCommit) []string
• func FetchJiraIssue(jiraClient *jira.Client, jiraIssueID string) (*jira.Issue, error)
• func FetchPR(ghClient *github.Client, number int) (*github.PullRequest, error)
• func FetchPRByTitle(ghClient *github.Client, title string) (*github.PullRequest, error)
• func FetchPRs(ghClient *github.Client, cutoff time.Time, opts *github.PullRequestListOptions) ([]*github.PullRequest, error)
• func FetchVersionPR(ghClient *github.Client, assert Assertion, versionToCompare semver.Version) (*github.PullRequest, error)
• func FetchVersionPRs(ghClient *github.Client, assert Assertion, versionToCompare semver.Version, ...) ([]*github.PullRequest, error)
• func GetCommitsBehind(client *github.Client, base, head string) ([]*github.RepositoryCommit, error)
• func InitGHClient() *github.Client
• func InitJiraClient() (*jira.Client, error)
• func IsMergedStatus(status string) bool
• func IsVersionBranch(branchName string) bool
• func JqlUnpaged(client *jira.Client, jql string) ([]jira.Issue, error)
• func LabelPR(ghClient *github.Client, prnumber int, labels []string) error
• func NewRateLimitTransport(rt http.RoundTripper, accessToken string) *rateLimitTransport
• func ParseJiraKey(v string) (string, error)
• func ParseJiraVersion(version string) (semver.Version, error)
• func ParseJiraVersionRaw(version string) string
• func SearchGithubIssues(client *github.Client, term string) ([]*github.Issue, error)
• func SetPRBody(client *github.Client, prnumber int, body string) error
• func UpdateJiraFixVersion(client *jira.Client, issue *jira.Issue, versionID string) error
• func UpdateJiraStatus(client *jira.Client, issue *jira.Issue, statusName string) error
• func UpdatePRTargetBranch(client *github.Client, prnumber int, targetBranch string) error
• func ValidVersionBranch(branchName string, version semver.Version) error
• func VersionFromPRTitle(title string) (semver.Version, error)
• func VersionedBranchName(version semver.Version) string
• func VersionedPRTitle(version semver.Version) string
• type Assertion
• type Version
  • func FetchAvailableVersions(jiraClient *jira.Client) ([]Version, error)
  • func ParseTargetFixVersion(issue *jira.Issue, availableVersions []Version) (target Version, original *jira.FixVersion, err error)

Constants

const (
	MasterBranch  = "master"
	StagingBranch = "beta"
	ReleaseBranch = "release"
)

const JiraStatusInProgress = "In Progress"

const JiraStatusPending = "Pending"

const JiraStatusTodo = "To Do"

const UpdateVersionCommitMessage = "Update version.txt"

const VersionNextFeasible = "Next Feasible"

const VersionNextUnscheduled = "Next Unscheduled"

const VersionedPRPrefix = "Version "

Variables

var VersionMaster = semver.MustParse("0.0.0")

Functions

func ActiveVersionsOnBranch

func ActiveVersionsOnBranch(ghClient *github.Client, jiraClient *jira.Client, branchName string, dateCutoff time.Time) ([]semver.Version, error)

func BranchHasVersionsGT

func BranchHasVersionsGT(client *github.Client, jiraClient *jira.Client, branchName string, version semver.Version) (bool, error)

func CreateBranch

func CreateBranch(ghClient *github.Client, branchName string, SHA string) error

func CreateFileUpdateCommit

func CreateFileUpdateCommit(ghClient *github.Client, branchName string, path string, contents string, message string) (string, error)

func CreatePR

func CreatePR(ghClient *github.Client, prName, branchName, baseBranch, body string) (*github.PullRequest, error)

func ExtractJiraIssueID

func ExtractJiraIssueID(pr *github.PullRequest) (string, error)

ExtractJiraIssueID tries to extract the jira issue ID from the branch name

func FetchCommitsByRef

func FetchCommitsByRef(ghClient *github.Client, ref string, stop func(commit *github.RepositoryCommit) bool) ([]*github.RepositoryCommit, error)

func FetchCommitsByShaRange

func FetchCommitsByShaRange(ghClient *github.Client, startSha string, stopSha string) ([]*github.RepositoryCommit, error)

func FetchJiraIDsInCommits

func FetchJiraIDsInCommits(commits []*github.RepositoryCommit) []string

func FetchJiraIssue

func FetchJiraIssue(jiraClient *jira.Client, jiraIssueID string) (*jira.Issue, error)

func FetchPR

func FetchPR(ghClient *github.Client, number int) (*github.PullRequest, error)

func FetchPRByTitle

func FetchPRByTitle(ghClient *github.Client, title string) (*github.PullRequest, error)

func FetchPRs

func FetchPRs(ghClient *github.Client, cutoff time.Time, opts *github.PullRequestListOptions) ([]*github.PullRequest, error)

FetchPRs fetches all PRs and iterates over all available pages

func FetchVersionPR

func FetchVersionPR(ghClient *github.Client, assert Assertion, versionToCompare semver.Version) (*github.PullRequest, error)

func FetchVersionPRs

func FetchVersionPRs(ghClient *github.Client, assert Assertion, versionToCompare semver.Version, limit int) ([]*github.PullRequest, error)

func GetCommitsBehind

func GetCommitsBehind(client *github.Client, base, head string) ([]*github.RepositoryCommit, error)

func InitGHClient

func InitGHClient() *github.Client

func InitJiraClient

func InitJiraClient() (*jira.Client, error)

func IsMergedStatus

func IsMergedStatus(status string) bool

func IsVersionBranch

func IsVersionBranch(branchName string) bool

func JqlUnpaged

func JqlUnpaged(client *jira.Client, jql string) ([]jira.Issue, error)

func LabelPR

func LabelPR(ghClient *github.Client, prnumber int, labels []string) error

func NewRateLimitTransport

func NewRateLimitTransport(rt http.RoundTripper, accessToken string) *rateLimitTransport

func ParseJiraKey

func ParseJiraKey(v string) (string, error)

func ParseJiraVersion

func ParseJiraVersion(version string) (semver.Version, error)

func ParseJiraVersionRaw

func ParseJiraVersionRaw(version string) string

func SearchGithubIssues

func SearchGithubIssues(client *github.Client, term string) ([]*github.Issue, error)

func SetPRBody

func SetPRBody(client *github.Client, prnumber int, body string) error

func UpdateJiraFixVersion

func UpdateJiraFixVersion(client *jira.Client, issue *jira.Issue, versionID string) error

func UpdateJiraStatus

func UpdateJiraStatus(client *jira.Client, issue *jira.Issue, statusName string) error

func UpdatePRTargetBranch

func UpdatePRTargetBranch(client *github.Client, prnumber int, targetBranch string) error

func ValidVersionBranch

func ValidVersionBranch(branchName string, version semver.Version) error

func VersionFromPRTitle

func VersionFromPRTitle(title string) (semver.Version, error)

func VersionedBranchName

func VersionedBranchName(version semver.Version) string

func VersionedPRTitle

func VersionedPRTitle(version semver.Version) string

Types

type Assertion

type Assertion string

const (
	AssertLT Assertion = "less than"
	AssertGT           = "greater than"
)

type Version

type Version struct {
	semver.Version
	JiraID string
}

func FetchAvailableVersions

func FetchAvailableVersions(jiraClient *jira.Client) ([]Version, error)

func ParseTargetFixVersion

func ParseTargetFixVersion(issue *jira.Issue, availableVersions []Version) (target Version, original *jira.FixVersion, err error)