feat: add alternative annotation pattern GUS-W- #168
Merged
Conversation
This file contains hidden or 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
This commit adds an alternative annotation pattern, `GUS-W-`, to be used to identify a work item. The reason for this is that GitHub autolinks (https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources#configuring-autolinks-to-reference-external-resources) do not support patterns that begin with symbols (such as `@`). In order to keep auto linking _and_ enable git2gus, we add support for this additional pattern. The pattern is case sensitive to help avoid issues with words ending with "gus" e.g. `argus`, `bogus`, `asparagus`.
|
Thanks for the contribution! Before we can merge this, we need @mble-sfdc to sign the Salesforce Inc. Contributor License Agreement. |
Contributor
Author
Kinda weird, I'm an internal user after all. |
mpsenn
approved these changes
May 9, 2023
Contributor
mpsenn
left a comment
mpsenn
left a comment
There was a problem hiding this comment.
I like the change, but since you mentioned avoiding partial matches, wonder what you think of a minor rex change.
api/services/Issues/getAnnotation.js
Outdated
| replace: /@/g | ||
| }, | ||
| { | ||
| rex: /GUS-W-\d+/g, |
Contributor
There was a problem hiding this comment.
How about \b at the start and end of this rex, so that only complete words are matched?
/\bGUS-W-\d+\b/g
Contributor
Author
There was a problem hiding this comment.
Sounds good - I'll make that change.
mpsenn
approved these changes
May 9, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This commit adds an alternative annotation pattern,
GUS-W-, to be used to identify a work item.The reason for this is that GitHub autolinks
(https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources#configuring-autolinks-to-reference-external-resources) do not support patterns that begin with symbols (such as
@). In order to keep auto linking and enable git2gus, we add support for this additional pattern.The pattern is case sensitive to help avoid issues with words ending with "gus" e.g.
argus,bogus,asparagus.