Pretty up previous TFC runs URLs list via markdown tables instead of just a list of URLs #35
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
…le item Signed-off-by: Alec Hinh <[email protected]>
Signed-off-by: Alec Hinh <[email protected]>
Signed-off-by: Alec Hinh <[email protected]>
Signed-off-by: Alec Hinh <[email protected]>
Signed-off-by: Alec Hinh <[email protected]>
Signed-off-by: Alec Hinh <[email protected]>
Signed-off-by: Alec Hinh <[email protected]>
Signed-off-by: Alec Hinh <[email protected]>
Signed-off-by: Alec Hinh <[email protected]>
Signed-off-by: Alec Hinh <[email protected]>
davidwin93
requested changes
Aug 4, 2023
pkg/vcs/github/client.go
Outdated
| runUrlRaw := utils.CaptureSubstring(runUrl, "[", "]") | ||
| runUrlSplit := strings.Split(runUrlRaw, "/") | ||
| // The run ID is the last part of the run URL, and it looks like run-abcd12345... | ||
| runID := runUrlSplit[len(runUrlSplit)-1] |
There was a problem hiding this comment.
We should have a check to ensure that runUrlSplit > 0 so it won't panic
pkg/vcs/gitlab/client.go
Outdated
| runUrlRaw := utils.CaptureSubstring(runUrl, "[", "]") | ||
| runUrlSplit := strings.Split(runUrlRaw, "/") | ||
| // The run ID is the last part of the run URL, and it looks like run-abcd12345... | ||
| runID := runUrlSplit[len(runUrlSplit)-1] |
There was a problem hiding this comment.
We should have a check to ensure that runUrlSplit > 0 so it won't panic
There was a problem hiding this comment.
Thanks for catching that - I also added a else condition in the event the runUrlSplit check fails to just fallback to original URL that was used before just so the has something rather than just an awkward blank table entry
pkg/vcs/gitlab/client.go
Outdated
| } | ||
|
|
||
| // Gitlab default sort is order by created by, so take the last match on this | ||
| oldRunBlockTest := utils.CaptureSubstring(note.Body, utils.URL_RUN_GROUP_PREFIX, utils.URL_RUN_GROUP_SUFFIX) | ||
| if oldRunBlockTest != "" { | ||
| oldRunBlock = oldRunBlockTest | ||
| } else { |
There was a problem hiding this comment.
this could be rewritten like this
oldRunBlock = "\n"
if oldRunBlockTest != "" {
oldRunBlock = oldRunBlockTest
}
pkg/vcs/github/client.go
Outdated
| } | ||
|
|
||
| // Github orders comments from earliest -> latest via ID, so we check each comment and take the last match on an "old url" block | ||
| oldRunBlockTest := utils.CaptureSubstring(comment.GetBody(), utils.URL_RUN_GROUP_PREFIX, utils.URL_RUN_GROUP_SUFFIX) | ||
| if oldRunBlockTest != "" { | ||
| oldRunBlock = oldRunBlockTest | ||
| } else { |
There was a problem hiding this comment.
this could be rewritten like this
oldRunBlock = "\n"
if oldRunBlockTest != "" {
oldRunBlock = oldRunBlockTest
}
Signed-off-by: Alec Hinh <[email protected]>
Signed-off-by: Alec Hinh <[email protected]>
Signed-off-by: Alec Hinh <[email protected]>
davidwin93
approved these changes
Aug 10, 2023
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.
Closes #34
Updates the placement of the previous TFC run URLs to use a markdown table instead.
Previously, the list looked like this:
Here is the proposed format:
Additionally, using tables I added a
Created atfield to show an exact timestamp of when the run was created (based on the MR creation timestamp) to allow for an easier view of when a TF run was made.And for compatibility with Github, I replaced the airplane_arriving emoji with 📥 as Github doesn't have the airplane arriving emoji.
Github testing
Unfortunately, I wasn't able to test these changes on Github as it doesn't seem like Github uses the MR run headers that Gitlab does. So while I've tested to make sure Github's functionality wasn't broken by these changes, I wasn't able to verify if the changes I ported from Gitlab also work on Github.