allowing JobUrl to the PlanSuccess model for github comment templating #5392
+341
−129
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
cpaloia
requested review from
GenPage,
lukemassa and
X-Guardian
and removed request for
a team
dosubot
bot
added
feature
|
I do not think policy checks have a URL status at all. |
X-Guardian
requested changes
Mar 9, 2025
There was a problem hiding this comment.
Can you update the PR title and description to detail what this PR is actually doing, i.e. adding the job URL to the plan success model which can then be used by a custom plan success template. Also please detail the changes you have made to LockURLGenerator and why.
It also needs markdown_renderer_test updating with tests for this change.
Co-authored-by: Simon Heather <[email protected]> Signed-off-by: Corey Aloia <[email protected]>
Signed-off-by: Corey Aloia <[email protected]>
cpaloia
changed the title
added 3 commits
March 14, 2025 20:34
|
Hi @X-Guardian I believe I have made the requested changes. Could you have another look when you get time? Thanks! |
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
This PR adds support for including the job URL in the GitHub comment template by adding the property
JobURLto thePlanSuccessmodel.This PR also renames the
LockURLGeneratortoURLGeneratoras it will be used for generating more than just the lock url. Currently the code already uses the router to fulfill this interface, so I have added the functionGenerateProjectJobURLwhich it gets from the router.Why
In certain cases, it's necessary to hide Terraform plan output in GitHub comments—such as in public repositories where the output may contain sensitive information. However, users may still need access to the plan details via a secure URL, such as one behind a firewall or ingress.
By including the job URL in the GitHub comment template (in addition to the existing GitHub check link), we provide users with clear guidance on why the output is hidden and where they can access it instead.
Tests
Tested locally by overriding the comment template and verifying the job URL was correctly included.
References
Notes
pegomockunless I downgraded Go to 1.23.0 ingo.mod.PolicyCheckResults, but I’m unsure whether those results are accessible via a URL. Would appreciate any feedback on this!