feat(automerge): implement GitHub --auto-merge-method flag for apply command #4895

a1k0u · 2024-09-04T09:26:33Z

what

Implemented flag which allows to specify merge method for the VCS (GitHub only for now) in automerge process.

atlantis apply --auto-merge-method merge
atlantis apply --auto-merge-method rebase
atlantis apply --auto-merge-method squash

why

In our company, Atlantis is used not only by DevOps/SRE/Ops engineers, but also by many developers from other teams. They have a different style of git commit messages, a different way of dividing code changes into commits. Sometimes we need to ask them to squash commits/rewrite the commit message.

This causes problems - after first review, the developers force changes (squash commits/rewrite the commit message), and then start the second atlantis plan, which must be reviewed a second time. Squash fixes this because the result commit message is a PR header that can be changed without any changes to the git history.

In the old logic, all methods except squash can be disabled, and this will fix the previous case, but maintenance engineers often work with a large task where a single pull request contains several independent commits that can be revert after merging into master.

Thus, these two cases conflict with each other, because we need to use different merge strategies in different situations.
This can be fixed if any flag is able to control the merge method for automerge function.

tests

I have tested my changes by extend TestGithubClient_MergePullCorrectMethod. Added tests in which the --auto-merge-method flag has the correct value, where correct value is not allowed and where value is not correct.

I have updated TestGithubClient_MergePullCorrectMethod test
I have tested my changes by running make test
I have tested my changes on test environment

references

(opened issue) Automerge support for "require linear history" #1176
(opened issue) Feature Request: Allow Auto Merge with Squash or Rebase option #2047

chenrui333 · 2024-09-12T20:01:04Z

@a1k0u Thanks for implementing this feature. Looks like there is some conflict before merging the PR.

a1k0u · 2024-09-13T06:16:38Z

@chenrui333
Thank you for review! I've resolved the conflict

a1k0u · 2024-09-25T18:31:48Z

@chenrui333, hi! Can you review this PR again, please?

a1k0u · 2024-10-07T14:41:52Z

@chenrui333 @jamengual @X-Guardian, hi! Can you review this PR again, please?

a1k0u · 2024-11-01T17:16:45Z

@chenrui333 @jamengual @X-Guardian @GenPage @lukemassa, hi! Any updates?

jamengual · 2024-11-01T18:47:23Z

@a1k0u, could you please sign the commit? sorry we have not gotten to your pr, but we have been more busy than normal

a1k0u · 2024-11-01T19:48:03Z

@jamengual, thank you! I've signed off the commit

X-Guardian

I think this option should be called automerge-method rather than merge-method to be clear that it is the method to be used for an auto-merge and not a normal merge.

runatlantis.io/docs/automerging.md

X-Guardian

Thanks @a1k0u. I've tested this on GitHub and it is working as expected, and on GitLab it is showing the correct error message.

Just some minor refinement to the error messages and we are good to go.

server/events/vcs/github_client.go

server/events/vcs/github_client_test.go

server/events/comment_parser.go

Signed-off-by: a1k0u <[email protected]>

….mod (main) (runatlantis#4968) Signed-off-by: X-Guardian <[email protected]> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: X-Guardian <[email protected]> Signed-off-by: a1k0u <[email protected]>

Co-authored-by: Simon Heather <[email protected]> Signed-off-by: Alexey Kosenko <[email protected]> Signed-off-by: a1k0u <[email protected]>

Signed-off-by: a1k0u <[email protected]>

a1k0u · 2024-11-02T19:37:27Z

@X-Guardian, thx! It looks great :)
I've merged your suggestions and updated comment_parser_test

X-Guardian · 2024-11-02T20:31:10Z

Thanks for your work on this @a1k0u. You can test it by using one of the following container images: dev-alpine-13fa635 or dev-debian-13fa635

…command (runatlantis#4895) Signed-off-by: a1k0u <[email protected]> Signed-off-by: X-Guardian <[email protected]>

a1k0u requested review from a team as code owners September 4, 2024 09:26

a1k0u requested review from GenPage, lukemassa and X-Guardian and removed request for a team September 4, 2024 09:26

github-actions bot added docs Documentation go Pull requests that update Go code provider/github labels Sep 4, 2024

chenrui333 added feature New functionality/enhancement and removed docs Documentation labels Sep 5, 2024

chenrui333 previously approved these changes Sep 12, 2024

View reviewed changes

a1k0u dismissed chenrui333’s stale review via 43e0a7a September 13, 2024 06:12

a1k0u force-pushed the specify-merge-method branch from aeabb57 to 43e0a7a Compare September 13, 2024 06:12

github-actions bot added the docs Documentation label Sep 13, 2024

a1k0u force-pushed the specify-merge-method branch from 43e0a7a to 20cbcc6 Compare September 17, 2024 12:51

a1k0u requested a review from chenrui333 September 18, 2024 08:21

a1k0u force-pushed the specify-merge-method branch from 20cbcc6 to 22788e2 Compare September 25, 2024 18:31

a1k0u force-pushed the specify-merge-method branch 2 times, most recently from 2d2aebe to 138d163 Compare October 7, 2024 14:40

a1k0u force-pushed the specify-merge-method branch 3 times, most recently from 022e7eb to 2fded7d Compare October 14, 2024 08:09

a1k0u force-pushed the specify-merge-method branch 2 times, most recently from 683404c to 63dfbea Compare November 1, 2024 19:46

a1k0u force-pushed the specify-merge-method branch from 63dfbea to c4564b7 Compare November 1, 2024 23:58

X-Guardian requested changes Nov 2, 2024

View reviewed changes

runatlantis.io/docs/automerging.md Outdated Show resolved Hide resolved

runatlantis.io/docs/automerging.md Outdated Show resolved Hide resolved

X-Guardian added the waiting-on-response Waiting for a response from the user label Nov 2, 2024

a1k0u force-pushed the specify-merge-method branch 2 times, most recently from 4b02fb3 to cf87803 Compare November 2, 2024 14:13

a1k0u changed the title ~~feat(automerge): implement --merge-method flag for apply command~~ feat(automerge): implement --auto-merge-method flag for apply command Nov 2, 2024

X-Guardian changed the title ~~feat(automerge): implement --auto-merge-method flag for apply command~~ feat(automerge): implement GitHub --auto-merge-method flag for apply command Nov 2, 2024

X-Guardian requested changes Nov 2, 2024

View reviewed changes

a1k0u and others added 5 commits November 2, 2024 22:30

feat(automerge): implement --merge-method flag for apply command

a1b4141

Signed-off-by: a1k0u <[email protected]>

chore(automerge): rename flag to --auto-merge-method

ce661d3

Signed-off-by: a1k0u <[email protected]>

chore(automerge): fix typo, improve error messages

1a3ff66

Co-authored-by: Simon Heather <[email protected]> Signed-off-by: Alexey Kosenko <[email protected]> Signed-off-by: a1k0u <[email protected]>

fix(automerge): update ApplyUsage in comment_parset_test

63d8e7e

Signed-off-by: a1k0u <[email protected]>

a1k0u force-pushed the specify-merge-method branch from e30e203 to 63d8e7e Compare November 2, 2024 19:30

github-actions bot added the dependencies PRs that update a dependency file label Nov 2, 2024

Merge branch 'main' into specify-merge-method

2b369f3

X-Guardian enabled auto-merge (squash) November 2, 2024 19:50

X-Guardian approved these changes Nov 2, 2024

View reviewed changes

X-Guardian merged commit 13fa635 into runatlantis:main Nov 2, 2024
34 checks passed

dosubot bot added the lgtm This PR has been approved by a maintainer label Nov 2, 2024

a1k0u added a commit to tufitko/atlantis that referenced this pull request Nov 6, 2024

feat(automerge): implement GitHub --auto-merge-method flag for apply …

e95c2d3

…command (runatlantis#4895) Signed-off-by: a1k0u <[email protected]> Signed-off-by: X-Guardian <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(automerge): implement GitHub --auto-merge-method flag for apply command #4895

feat(automerge): implement GitHub --auto-merge-method flag for apply command #4895

a1k0u commented Sep 4, 2024 •

edited

Loading

chenrui333 commented Sep 12, 2024

a1k0u commented Sep 13, 2024 •

edited

Loading

a1k0u commented Sep 25, 2024

a1k0u commented Oct 7, 2024

a1k0u commented Nov 1, 2024 •

edited

Loading

jamengual commented Nov 1, 2024

a1k0u commented Nov 1, 2024

X-Guardian left a comment

X-Guardian left a comment

a1k0u commented Nov 2, 2024 •

edited

Loading

X-Guardian commented Nov 2, 2024 •

edited

Loading

feat(automerge): implement GitHub --auto-merge-method flag for apply command #4895

feat(automerge): implement GitHub --auto-merge-method flag for apply command #4895

Conversation

a1k0u commented Sep 4, 2024 • edited Loading

what

why

tests

references

chenrui333 commented Sep 12, 2024

a1k0u commented Sep 13, 2024 • edited Loading

a1k0u commented Sep 25, 2024

a1k0u commented Oct 7, 2024

a1k0u commented Nov 1, 2024 • edited Loading

jamengual commented Nov 1, 2024

a1k0u commented Nov 1, 2024

X-Guardian left a comment

Choose a reason for hiding this comment

X-Guardian left a comment

Choose a reason for hiding this comment

a1k0u commented Nov 2, 2024 • edited Loading

X-Guardian commented Nov 2, 2024 • edited Loading

a1k0u commented Sep 4, 2024 •

edited

Loading

a1k0u commented Sep 13, 2024 •

edited

Loading

a1k0u commented Nov 1, 2024 •

edited

Loading

a1k0u commented Nov 2, 2024 •

edited

Loading

X-Guardian commented Nov 2, 2024 •

edited

Loading