Improve promotion comment. #31
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
ashvarts
requested review from
a team,
hnnsgstfssn,
Freyert,
Oded-B,
yzdann and
sunchill06
ashvarts
force-pushed
the
sd-770-ux-improvement---promotion-pr-description-to-list-specific-targets
branch
from
301f819 to
884262f
Compare
hnnsgstfssn
reviewed
Oct 22, 2024
internal/pkg/githubapi/github.go
Outdated
| // returns a slice containing paths in common. | ||
| func identifyCommonPaths(promotionPaths []string, targetPaths []string) []string { | ||
| if (len(promotionPaths) == 0) || (len(targetPaths) == 0) { | ||
| return []string{} |
There was a problem hiding this comment.
Suggested change
| return []string{} | |
| return nil |
internal/pkg/githubapi/github.go
Outdated
| if (len(promotionPaths) == 0) || (len(targetPaths) == 0) { | ||
| return []string{} | ||
| } | ||
| commonPaths := []string{} |
There was a problem hiding this comment.
Suggested change
| commonPaths := []string{} | |
| var commonPaths []string |
| continue | ||
| } | ||
| // strings.HasPrefix is used to check that the target path and promotion path match instead of | ||
| // using 'pp == tp' because the promotion path is targetPath + component. |
There was a problem hiding this comment.
Is this always true? I'm missing some context about how the paths are built/where they come from so it isn't fully clear to me that this covers all cases.
If this does the job and solves the current issue I'm happy to get it in for now.
There was a problem hiding this comment.
ashvarts
force-pushed
the
sd-770-ux-improvement---promotion-pr-description-to-list-specific-targets
branch
from
bce2a55 to
a2ced16
Compare
ashvarts
force-pushed
the
sd-770-ux-improvement---promotion-pr-description-to-list-specific-targets
branch
from
0070c89 to
4840d62
Compare
hnnsgstfssn
previously approved these changes
Oct 23, 2024
Promotion comment used to list all the values in the 'targetPaths' key, ignoring the promotionAllow and promotionBlock lists. This PR limits the comment to only paths that are being promoted.
ashvarts
force-pushed
the
sd-770-ux-improvement---promotion-pr-description-to-list-specific-targets
branch
from
4840d62 to
5c71edd
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.
Description
Please provide a meaningful description of what this change will do, or is for. Bonus points for including links to related issues, other PRs, or technical references.
Note that by not including a description, you are asking reviewers to do extra work to understand the context of this change, which may lead to your PR taking much longer to review, or result in it not being reviewed at all.
Type of Change
Checklist