JiraProvider
Defined in: alm/jira.ts:25
An AlmProvider for Jira, which keys issues as PROJECT-123.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new JiraProvider():
JiraProvider
Returns
Section titled “Returns”JiraProvider
Methods
Section titled “Methods”extractIssues()
Section titled “extractIssues()”extractIssues(
commitLog,projectKeys):AlmIssueRef[]
Defined in: alm/jira.ts:31
Finds issue references in a commit log. projectKeys is only meaningful for prefix-keyed
trackers such as Jira; trackers that number issues per repository ignore it.
Parameters
Section titled “Parameters”commitLog
Section titled “commitLog”string
projectKeys
Section titled “projectKeys”string[]
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”render()
Section titled “render()”render(
issues,baseUrl?):AlmIssueRendering
Defined in: alm/jira.ts:44
Renders references as plain text, and as HTML links when baseUrl is provided.
Parameters
Section titled “Parameters”issues
Section titled “issues”baseUrl?
Section titled “baseUrl?”string
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”Properties
Section titled “Properties”issueNoun
Section titled “issueNoun”
readonlyissueNoun:"story"='story'
Defined in: alm/jira.ts:28
What this tool calls the things it tracks, for user-facing text.
Implementation of
Section titled “Implementation of”
readonlykind:"jira"
Defined in: alm/jira.ts:26