docs: fill all command line flags not in the document, and more. #2568
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nitrocode
reviewed
Oct 7, 2022
| @@ -114,6 +114,10 @@ the Atlantis user needs to be part of that list in order for it to consider | |||
| a pull request mergeable. | |||
| ::: | |||
|
|
|||
| ::: warning | |||
| If you set `atlantis/apply` to the mergeable requirement, use `--gh-allow-mergeable-bypass-apply` flag. This flag allows the mergeable check before `apply` to skip checking the status of `atlantis/apply`. | |||
There was a problem hiding this comment.
Can we also document the ATLANTIS_GH_MERGEABLE_BYPASS_APPLY=true env var too ?
There was a problem hiding this comment.
Looks like the flag is documented here https://www.runatlantis.io/docs/server-configuration.html#gh-allow-mergeable-bypass-apply but it doesnt show the env var.
It also shows a bullet where there shouldn't be a bullet.
There was a problem hiding this comment.
@nitrocode Thanks for your comment!
I have fixed a wrong bullet and documented the env var to apply-requirements.md. On the other hand, I have not appended the env var to server-configuration.md because there is no mention of env vars in the other flags (Excluding a few. Lack uniformity...).
jamengual
approved these changes
Oct 8, 2022
|
@chroju Thanks for the contribution |
krrrr38
pushed a commit
to krrrr38/atlantis
that referenced
this pull request
Dec 16, 2022
…atlantis#2568) * docs: All command line flags are filled in the doc * docs: about --gh-allow-mergeable-bypass-apply flag * docs: replace Github with GitHub * docs: remove an incorrect bullet Co-authored-by: chroju <chroju@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add documents.
server/server.go, related:--hide-prev-plan-commentsflag fails if using Github App name with uppercased or space chars #1161 .atlantis/applystatus check work withmergeableusing--gh-allow-mergeable-bypass-apply#2436 .