fix: Change message for when request is not approved to be more accurate #3744
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
lukemassa
changed the title
jamengual
approved these changes
Sep 6, 2023
There was a problem hiding this comment.
Thanks @lukemassa for the contribution.
I agree the message at this time is deceiving since as you say there are my other ways to restrict approvals.
This was referenced Oct 6, 2023
ijames-gc
pushed a commit
to gocardless/atlantis
that referenced
this pull request
Feb 13, 2024
…ate (runatlantis#3744) * Change message for when request is not approved * Updates * Fix * Fix tests
ijames-gc
pushed a commit
to gocardless/atlantis
that referenced
this pull request
Feb 13, 2024
…ate (runatlantis#3744) * Change message for when request is not approved * Updates * Fix * Fix tests
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
Changed verbiage on comment that is posted on a PR when the approval is required and not given.
why
The comment currently says "Pull request must be approved by at least one person other than the author before running apply". However that's not always true. What the code is actually looking for is for whether the relevant VCS calls this request "approved". In my case of gitlab, but presumably in other VCSs as well, there are a lot of things that could go into determining whether an approval is "sufficient" or not, which may or may not include a person other than the other approving. This causes confusion for users who, understandably, think they need to find someone else to approve their MR, when they might not.
Additionally, I don't see any code in https://github.com/runatlantis/atlantis/tree/master/server/events/vcs that would indicate that atlantis has logic that expects an approval by "at least one person other than the author".
It would potentially be better (but a lot more work) to have the VCSs expose a description of what it meant for a specific PR to be approved, and relay that to the end user. That's a possible followup from this, but this change at least makes the statement more accurate.
tests
I ran unit tests, should be sufficient since it's just changing a string.
references
closes #2290 (which was already closed by virtue of being stale).