-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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.
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
docs: add more commands in using-atlantis.md #2808
docs: add more commands in using-atlantis.md #2808
Conversation
--- | ||
## atlantis plan | ||
 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's difficult to capture same image for other commands. So just show one image on the page top.
|
||
### Explanation | ||
Removes all atlantis locks and discards all plans for this PR. | ||
To unlock a specific plan you can use the Atlantis UI. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
copy from
atlantis/server/events/comment_parser_test.go
Lines 755 to 765 in 6a7f79e
Commands: | |
plan Runs 'terraform plan' for the changes in this pull request. | |
To plan a specific project, use the -d, -w and -p flags. | |
apply Runs 'terraform apply' on all unapplied plans from this pull request. | |
To only apply a specific plan, use the -d, -w and -p flags. | |
unlock Removes all atlantis locks and discards all plans for this PR. | |
To unlock a specific plan you can use the Atlantis UI. | |
approve_policies | |
Approves all current policy checking failures for the PR. | |
version Print the output of 'terraform version' | |
help View help. |
* `run` is a global executable name. | ||
* `@GithubUser help` | ||
* `@GithubUser` is the VCS host user which you connected to Atlantis by user token. | ||
::: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO it is better to drop run help
feature... it seems a little bit hidden function.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's your opinion to drop the run help
feature because it's a hidden function?
Wouldn't you want to add the run help
feature because it's a hidden function?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I want to remove run help
feature. so remove this doc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why remove the run help
feature?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess no one use run apply
and almost users doesnot know this feature. Not to execute it untentionally by just comment it, I think it is better to drop it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's possible people still use it. We don't collect analytics for this. It's probably best not to introduce a breaking change, no?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
True. Generally, we should not do a breaking change. it must be introduced into major update and so on. In this PR, just add docs and not to drop it and so on. Currently, we already provide this feature, so I add docs 👌
@krrrr38 also you can click the details link on the https://deploy-preview-2808--runatlantis.netlify.app/docs/using-atlantis.html#using-atlantis |
Thank you @krrrr38 for improving the documentation! |
what
executable name
How Atlantis Works
children linkslocalhost:8080/docs/using-atlantis.html
why
version/unlock/approve_policies commands are not documented in that page.
references