Skip to content

getCommitStories

getCommitStories(previousVersion, targetVersion, almProjectKey, options?): Promise<CommitStories>

Defined in: packages/simply-cicd-core/src/notify/getCommitStories.ts:65

Retrieves issue references from the commit logs between two tags/commits. Fetches the git history, hands the commit messages to the configured AlmProvider to recognize and render its own reference format, and returns both a plain string and (if almBaseUrl is provided) an HTML list with hyperlinks.

string | undefined

string | undefined

string | undefined

GetCommitStoriesOptions

Promise<CommitStories>