branchhelper

Documentation

Index

• func GuessEndpointURL(issueURL *url.URL) string
• type EndpointCombinedStrategy
  • func (c EndpointCombinedStrategy) GetEndpoint(issueURL *url.URL) *url.URL
• type EndpointSoloStrategy
  • func (c EndpointSoloStrategy) GetEndpoint(issueURL *url.URL) *url.URL
• type EndpointStrategy
• type GetIssueClient
• type IssueLiteralStrategy
  • func (c IssueLiteralStrategy) GetIssue(rawIssue string) (string, error)
• type IssueStrategy
  • func MakeIssueStrategy(issueURL *url.URL) IssueStrategy
• type IssueURLStrategy
  • func (c IssueURLStrategy) GetIssue(rawIssue string) (string, error)
• type Jira
  • func NewJira(client *jira.Client) *Jira
  • func (helper *Jira) FormatIssue(issueID string, rawTmpl string) (string, error)

Functions

func GuessEndpointURL

func GuessEndpointURL(issueURL *url.URL) string

GuessEndpointURL Guesses the endpoint URL from a issue URL

Types

type EndpointCombinedStrategy

type EndpointCombinedStrategy struct {
}

EndpointCombinedStrategy is used for instances Jira is deployed with other products, so has the "/jira" prefix e.g. "/jira/browse/TST-1"

func (EndpointCombinedStrategy) GetEndpoint

func (c EndpointCombinedStrategy) GetEndpoint(issueURL *url.URL) *url.URL

GetEndpoint Try to get a endpoint URL from a issue url using the EndpointCombinedStrategy

type EndpointSoloStrategy

type EndpointSoloStrategy struct {
}

EndpointSoloStrategy is used for instances Jira is deployed alone, so has no prefix to issues e.g. "/browse/TST-1"

func (EndpointSoloStrategy) GetEndpoint

func (c EndpointSoloStrategy) GetEndpoint(issueURL *url.URL) *url.URL

GetEndpoint Try to get a endpoint URL from a issue url using the EndpointSoloStrategy

type EndpointStrategy

type EndpointStrategy interface {
	GetEndpoint(url *url.URL) *url.URL
}

EndpointStrategy Get an endpoint URL from an issue URL

type GetIssueClient

type GetIssueClient interface {
	Get(
		issueID string,
		options *jira.GetQueryOptions,
	) (
		*jira.Issue,
		*jira.Response,
		error,
	)
}

GetIssueClient allows us to get issues from Jira

type IssueLiteralStrategy

type IssueLiteralStrategy struct {
}

IssueLiteralStrategy take what the user provided verboten

func (IssueLiteralStrategy) GetIssue

func (c IssueLiteralStrategy) GetIssue(rawIssue string) (string, error)

GetIssue extracts the issue number from the issue

type IssueStrategy

type IssueStrategy interface {
	GetIssue(rawIssue string) (string, error)
}

IssueStrategy strategy to use to take a user supplied issue and convert it to a standard Jira issue

func MakeIssueStrategy

func MakeIssueStrategy(
	issueURL *url.URL,
) IssueStrategy

MakeIssueStrategy make an issue strategy based on the URL provided

type IssueURLStrategy

type IssueURLStrategy struct {
}

IssueURLStrategy take what the user provided, assume it's a URL take the issue number from the end

func (IssueURLStrategy) GetIssue

func (c IssueURLStrategy) GetIssue(rawIssue string) (string, error)

GetIssue extracts the issue number from the issue

type Jira

type Jira struct {
	Client GetIssueClient
}

Jira will generate branch names from Jira issues

func NewJira

func NewJira(
	client *jira.Client,
) *Jira

NewJira from a Jira client build a client helper

func (*Jira) FormatIssue

func (helper *Jira) FormatIssue(
	issueID string,
	rawTmpl string,
) (string, error)

FormatIssue generate a branch name from a template and a issue ID