Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): Update docs for --hide-prev-plan-comments and UnDiverged #4105

Merged
merged 3 commits into from
Dec 28, 2023
Merged

feat(docs): Update docs for --hide-prev-plan-comments and UnDiverged #4105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
130c197
Update runatlantis.io/docs/server-configuration.md
keidarcy Dec 28, 2023
7186afb
runatlantis.io/docs/command-requirements.md
keidarcy Dec 28, 2023
038018b
Update server-configuration.md
keidarcy Dec 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion runatlantis.io/docs/command-requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions runatlantis.io/docs/server-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down
Loading