feat: expose JiraIssue.BaseURL and JiraIssue.BrowseURL #258
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
As outlined in git-chglog#183 it can be useful when following the conventional commit syntax to separate conventional commit type in the subject from work item references which often appear in the commit body or commit footer this commit: - adds a new config option 'jira.issue.key_pattern' which is an optional regex used to match issue keys in the commit subject and body - ensures that the Jira Issue Type does not overwrite a Conventional Commit Type; the 'jira.issue.type_maps' map is only used as a backup when the Conventional Commit Type parsed out of the Subject header is empty - runs the 'jira.issue.key_pattern' regex against both the commit Subject header and the entire commit Body NOTE: the current code assumes that only one Jira work item will be bound to a single commit, and this appears consistent with the spirit of Conventional Commits. I have sometimes found it useful to write a Conventional Commit where one 'fix' can close multiple Jira work items, so a future issue/change might consider updating the model to support multiple Jira work items in a single commit message.
allows the release note templates to easily create hyperlinks
into jira like
Jira: {{ print .JiraIssue.BaseURL "/browse/" .JiraIssueID }}
or
Jira: {{ .JiraIssue.BrowseURL }}
resolves: git-chglog#251
davidalpert
force-pushed
the
GH-251-expose-jiraurl-to-templates
branch
from
68728b3
to
8ec17f6
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this do / why do we need it?
As noted in #251 it is often useful to include in release notes a link to the ticketing system or to the specific work item ticket which may have more information on the requirements or background for that piece of work.
How this PR fixes the problem?
This PR offers a commit which adds two new properties to the object avaialble for reference in the templates:
.JiraIssue.BaseURLoptions.jira.info.urlorJIRA_URL, the Base URL of the Jira instance.JiraIssue.BrowseURL{{BaseURL}}/browse/{{IssueKey}What should your reviewer look out for in this PR?
This PR is based on top of #257 so as to reduce merge conflicts, since they both update the Jira features.
Check lists
Which issue(s) does this PR fix?
Resolves #251