Referred issues placeholder #77
Merged
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
This method was hard to build due to the complications of working with regex. However, because the entire method can work on a string and does not require any other dependencies, it made sense to expose it as a single exported function in a utils file. This made testing a lot easier, because it does not require us to do any additional setup. The tests are structured in a way to test the most common cases and the helper method is created to allow the test code to focus on test cases. In ES2020, string.matchAll is added which allows capturing groups of all matches. Using this we would not have to execute the url pattern on each individual matched url again to find the capture groups (which we use to construct the issue reference). Sadly, ES2020 is not available in nodejs 12 which is used by default for github actions.
The placeholder ${issue_refs} is replaced with all issues mentioned in
the original pull request's body. Urls are tranformed into actual GitHub
refs (like org/repo#number). External repo issue reference still refer
to the external repo. Finally, all indidividual references are seperated
by a space when used to replace the placeholder.
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.
Adds a new placeholder
${issue_refs}to be used in custom pull descriptions introduced in #64.This placeholder will be replaced with all issues mentioned in the original pull request's description (aka body). Issue mentions can be GitHub issue references (e.g.
#123orzeebe-io/backport-action#123) or urls to GitHub issues.This supports reference to issues in external repositories. For GitHub references, the full reference is kept in-tact as is, but urls are always transformed into the full reference (i.e. including the org and repo) even for local repo references.
closes #3
Tested successfully in https://github.com/zeebe-io/automation-lab/pull/67