From c403d07365007c7f6cc7eb557917159c58e322fe Mon Sep 17 00:00:00 2001 From: Alexander Dupuy <75610395+dupuy26@users.noreply.github.com> Date: Fri, 1 Oct 2021 15:59:39 +0200 Subject: [PATCH] docs: document --auto-merge-disabled option (#1838) This flag was added in #1533 but was not documented. --- runatlantis.io/docs/automerging.md | 4 ++++ runatlantis.io/docs/using-atlantis.md | 1 + 2 files changed, 5 insertions(+) diff --git a/runatlantis.io/docs/automerging.md b/runatlantis.io/docs/automerging.md index 440e8b9b04..b0f4cdfe61 100644 --- a/runatlantis.io/docs/automerging.md +++ b/runatlantis.io/docs/automerging.md @@ -21,6 +21,10 @@ Automerging can be enabled either by: to be configured under the `projects` key. ::: +## How to Disable +If automerge is enabled, you can disable it for a single `atlantis apply` +command with the `--auto-merge-disabled` option. + ## All Plans Must Succeed When automerge is enabled, **all plans** in a pull request **must succeed** before **any** plans can be applied. diff --git a/runatlantis.io/docs/using-atlantis.md b/runatlantis.io/docs/using-atlantis.md index 24a0a29352..4695831e81 100644 --- a/runatlantis.io/docs/using-atlantis.md +++ b/runatlantis.io/docs/using-atlantis.md @@ -86,6 +86,7 @@ atlantis apply -w staging * `-d directory` Apply the plan for this directory, relative to root of repo. Use `.` for root. * `-p project` Apply the plan for this project. Refers to the name of the project configured in the repo's [`atlantis.yaml` file](repo-level-atlantis-yaml.html). Cannot be used at same time as `-d` or `-w`. * `-w workspace` Apply the plan for this [Terraform workspace](https://www.terraform.io/docs/state/workspaces.html). If not using Terraform workspaces you can ignore this. +* `--auto-merge-disabled` Disable [automerge](automerging.html) for this apply command. * `--verbose` Append Atlantis log to comment. ### Additional Terraform flags