fix(branch-planner): prevent duplicate comments by checking plan rev #1614
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
…sion The branch planner was posting duplicate comments on pull requests because isNewPlan() only checked if the LastPlanAt timestamp changed, not whether the actual plan content (LastPlannedRevision) changed. This caused the informer to repeatedly detect the same plan as "new" across reconciliation loops, triggering duplicate git provider comments for the same terraform plan. Changes: - Add early return if LastPlannedRevision is empty to avoid processing incomplete status updates - Check both LastPlanAt timestamp AND LastPlannedRevision when determining if a plan is truly new - Only post comments when the plan revision actually changes, not just the timestamp This ensures comments are posted once per unique plan, preventing spam on pull requests during reconciliation loops. Signed-off-by: Loic Yavercovski <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
While using github integration for branch-planner, I noticed that a comment with the plan was posted after each reconcilation of the plan (interval: 1m) even when no changes were made.
The branch planner was posting duplicate comments on pull requests because isNewPlan() only checked if the LastPlanAt timestamp changed, not whether the actual plan content (LastPlannedRevision) changed.
This caused the informer to repeatedly detect the same plan as "new" across reconciliation loops, triggering duplicate git provider comments for the same terraform plan.
Changes:
This ensures comments are posted once per unique plan, preventing spam on pull requests during reconciliation loops.