From 8f8c4d048b65b39486b8b4caea86e381ade0ab92 Mon Sep 17 00:00:00 2001 From: Xing Yahao Date: Fri, 29 Dec 2023 04:30:01 +0900 Subject: [PATCH] feat(docs): Update docs for `--hide-prev-plan-comments` and `UnDiverged` (#4105) * Update runatlantis.io/docs/server-configuration.md * runatlantis.io/docs/command-requirements.md * Update server-configuration.md --- runatlantis.io/docs/command-requirements.md | 2 +- runatlantis.io/docs/server-configuration.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/runatlantis.io/docs/command-requirements.md b/runatlantis.io/docs/command-requirements.md index df8b2761f5..e3aea4ea21 100644 --- a/runatlantis.io/docs/command-requirements.md +++ b/runatlantis.io/docs/command-requirements.md @@ -148,7 +148,7 @@ At this time, the Azure DevOps client only supports merging using the default 'n ### UnDiverged Prevent applies if there are any changes on the base branch since the most recent plan. -Applies to `merge` checkout strategy only. +Applies to `merge` checkout strategy only which you need to set via `--checkout-strategy` flag. #### Usage You can set the `undiverged` requirement by: diff --git a/runatlantis.io/docs/server-configuration.md b/runatlantis.io/docs/server-configuration.md index 6781abb149..1c06fed979 100644 --- a/runatlantis.io/docs/server-configuration.md +++ b/runatlantis.io/docs/server-configuration.md @@ -467,7 +467,7 @@ and set `--autoplan-modules` to `false`. ```bash atlantis server --fail-on-pre-workflow-hook-error # or - ATLANTIS_FAIL_ON_PRE_WORKFLOW_HOOK_ERROR=true + ATLANTIS_FAIL_ON_PRE_WORKFLOW_HOOK_ERROR=true ``` Fail and do not run the requested Atlantis command if any of the pre workflow hooks error. @@ -648,7 +648,7 @@ and set `--autoplan-modules` to `false`. ATLANTIS_HIDE_PREV_PLAN_COMMENTS=true ``` Hide previous plan comments to declutter PRs. This is only supported in - GitHub and GitLab currently. This is not enabled by default. + GitHub and GitLab currently. This is not enabled by default. When using Github App, you need to set `--gh-app-slug` to enable this feature. ### `--hide-unchanged-plan-comments` ```bash