Webhook Event for Manual Plan Validation

[tchelovilar]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request. Searching for pre-existing feature requests helps us consolidate data points for identical requirements into a single place, thank you!
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.
• If you are interested in working on this issue or have submitted a pull request, please leave a comment.

---

• [ ] I'd be willing to implement this feature (contributing guide)

Describe the user story

Enable Atlantis to execute periodic plans and validate that the infrastructure matches the desired state. Since Atlantis already has all the necessary credentials to run the plan, having a way to request plan validation makes sense. It aligns well to maintain infrastructure consistency.

Describe the solution you'd like

Add a webhook event that allows manual triggering of a project plan. If the current Terraform state file is not up to date, Atlantis will create a pull request (PR) with the plan. This approach enables administrators to review the plan and ensures that the infrastructure aligns with the desired state.

For GitHub, GitHub Actions cron workflow can be used to schedule the plans, and the workflow_job webhook event could serve as the trigger. Based on the workflow name and the job name, the appropriate Atlantis project would be selected for planning.

https://docs.github.com/en/webhooks/webhook-events-and-payloads#workflow_job

Describe the drawbacks of your solution

Describe alternatives you've considered

Currently, that validation can be done by GitHub actions, but then extra credentials and automation is required.