feat: disable autoplan label

[ghaiszaher]

what

• Add new flag to allow disabling auto-planning only on pull requests that have a certain label
• Command line flag: --disable-autoplan-label=<string>
• Environment variable: ATLANTIS_DISABLE_AUTOPLAN_LABEL=<string>
• If --disable-autoplan flag is set to true, the new flag --disable-autoplan-label has no effect
• If --disable-autoplan-label is unset or if it's an empty string, it will have no effect

why

We encounter this especially in a large repository used by many developers. It gets hard to manage the lock queue so we use an external bot to manage the queue for us. Only in certain pull requests, we don't want the autoplan feature to kick in.

• Example 1: Working on a multi-project pull request and some locks are taken by other pull requests. You'd rather wait until all locks are free before planning all the directories (in the meantime, you receive pull request reviews and push commits to the PR)
• Example 2: A pull request that is marked as ready for review but requires some changes and you don't want to keep acquiring the lock on each commit
• Example 3: Automations that create pull requests but you don't want them to take the lock on each created PR.

tests

Tested with a Github pull request and environment variable ATLANTIS_DISABLE_AUTOPLAN_LABEL=no-autoplan.

1. Adding the label then pushing a commit:

2. Creating a pull request with that label doesn't trigger a plan:

3. Creating a pull request without the label still plans:

references

• Option to ignore or skip a PR for autoplanning by github label/comment #632
• Disable auto-planning for a specific PR #932
• feat: skip autoplan if a pull request matches skip keywords for GitHub #1799

[raynigon]

LGTM

It would be nice to have more test coverage for the VCS implementations.
Because the other clients can be implemented on an "On Demand" bases, this PR can be merged without these implementations.

[raynigon]

LGTM

[ghaiszaher]

@jamengual @GenPage @chenrui333 could you take a look at this PR? We'd love to have the feature included in the next release.

[raizyr]

I found this because I also need this feature. My use case is that I have a pull request created via automation and need to include terraform args to replace some resources. ie. atlantis plan -p project_a -- -replace="resource.to_replace". The automation creates a PR triggering autoplan, then the comment to plan & replace is added which Atlantis replies with a Plan error because the workspace is locked by the autoplan. Being able to create the PR and have Atlantis skip the autoplan would be ideal.

[GenPage]

I will be taking a look over the weekend.

[GenPage]

LGTM, good tests. Thank you for the feature contribution

[X-Guardian]

Hi @ghaiszaher, just wanted to say thankyou for coming up with this feature, as it has made our apply/rebase/merge process much quicker on our infra repo!

[brandon-fryslie]

We've had plan locks turned off entirely (both Atlantis and Terraform) in our dev environment and there seem to be 0 consequences. It's been months. They were a massive bottleneck.

[jamengual]

a lot of people use them and they are quite happy since it fits their development workflow and others like you prefer not to use them, it is a choice but not a bottleneck.

…

On Thu, Jan 11, 2024, 9:15 a.m. Brandon Fryslie ***@***.***> wrote: We've had plan locks turned off entirely (both Atlantis and Terraform) in our dev environment and there seem to be 0 consequences. It's been months. They were a massive bottleneck. — Reply to this email directly, view it on GitHub <#3649 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAQ3ERF42HMWQF3JDN2VDX3YN7JXVAVCNFSM6AAAAAA3FNQCASVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQOBXGAZTOMJTGU> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[nitrocode]

I've sometimes wondered if removing the locks is a working solution. Good to know that some people have disabled it and it's working for them. I would hope that if you do not run into edge cases then maybe we can disable locking in atlantis by default and turn it on with a flag when users want it.

[nitrocode]

@brandon-fryslie please see #2876