Skip to content

getIssueReferences

Collects the issue numbers of one repository that a set of commit messages names, and whether each was named with a closing keyword.

Three forms count: a bare #12, <owner>/<name>#12, and the repository’s issues/12 or pull/12 URL. A bare #12 glued to a preceding token (other#12, other/repo#12, &#12) does not. A mention is closing when GitHub’s own closing keyword precedes it directly: close, closes, closed, fix, fixes, fixed, resolve, resolves or resolved, in any case, optionally followed by a colon.

Import:

import { getIssueReferences } from 'obsidian-dev-utils/script-utils/released-issues';

Signature:

function getIssueReferences(params: GetIssueReferencesParams): IssueReference[]

Parameters:

Parameter Type Description
params GetIssueReferencesParams The GetIssueReferencesParams.

Returns: IssueReference[] — The references, sorted by number, one per number.


Links to this page: