AlmProvider
Defined in: alm/types.ts:41
An issue-tracker integration, abstracted so that the notification path never encodes one tool’s key format or link shape. Only the parts that genuinely differ between trackers live here: how a reference is recognized in a commit message, and how it is displayed and linked.
Methods
Section titled “Methods”extractIssues()
Section titled “extractIssues()”extractIssues(
commitLog,projectKeys):AlmIssueRef[]
Defined in: alm/types.ts:51
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”render()
Section titled “render()”render(
issues,baseUrl?):AlmIssueRendering
Defined in: alm/types.ts:54
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”Properties
Section titled “Properties”issueNoun
Section titled “issueNoun”
readonlyissueNoun:string
Defined in: alm/types.ts:45
What this tool calls the things it tracks, for user-facing text.
readonlykind:AlmProviderKind
Defined in: alm/types.ts:42