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

Jump to bottom

docs(using-atlantis): add usage for -destroy flag in atlantis plan #3755

Merged
merged 7 commits into from
Sep 11, 2023
Merged

docs(using-atlantis): add usage for -destroy flag in atlantis plan #3755

merged 7 commits into from
Sep 11, 2023

Conversation

leylmordor
Copy link
Contributor

what

  • Added usage instructions and a cautionary note for the -destroy flag in the atlantis plan command.
  • Included a disclaimer to warn users about the potential risks of using the -destroy flag.

why

  • To provide users with clear instructions on how to use the -destroy flag in atlantis plan.
  • To emphasize the importance of caution when performing destructive plans to prevent data loss or disruptions.

@leylmordor leylmordor requested a review from a team as a code owner September 8, 2023 07:11
@github-actions github-actions bot added the docs Documentation label Sep 8, 2023
jamengual
jamengual reviewed Sep 8, 2023
View reviewed changes
Copy link
Contributor

@jamengual jamengual left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the contribution @leylmordor

runatlantis.io/docs/using-atlantis.md Outdated Show resolved Hide resolved
runatlantis.io/docs/using-atlantis.md
To perform a destructive plan that will destroy resources in the specified directory, you can use the `-destroy` flag like this:

```bash
atlantis plan -d dir -- -destroy
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
atlantis plan -d dir -- -destroy
atlantis plan -- -destroy

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are cases where users may run on a different directory, so I think atlantis plan -d dir -- -destroy this could also be useful for new users to have

runatlantis.io/docs/using-atlantis.md Outdated Show resolved Hide resolved
@GenPage GenPage added the waiting-on-response Waiting for a response from the user label Sep 11, 2023
GenPage
GenPage approved these changes Sep 11, 2023
View reviewed changes
Copy link
Member

@GenPage GenPage left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@GenPage GenPage removed the waiting-on-response Waiting for a response from the user label Sep 11, 2023
@GenPage GenPage merged commit ca5aa85 into runatlantis:main Sep 11, 2023
@leylmordor leylmordor mentioned this pull request Sep 19, 2023
Closed
1 task
ijames-gc pushed a commit to gocardless/atlantis that referenced this pull request Feb 13, 2024
@leylmordor @jamengual @ijames-gc
docs(using-atlantis): add usage for -destroy flag in atlantis plan (r…
7e8c252 
…unatlantis#3755)

* docs(using-atlantis): add usage for -destroy flag in atlantis plan

Signed-off-by: Abdulla Mulail Mohamed <[email protected]>

* docs(using-atlantis): add closing to caution note

Signed-off-by: Abdulla Mulail Mohamed <[email protected]>

* Update runatlantis.io/docs/using-atlantis.md

Co-authored-by: PePe Amengual <[email protected]>

* Update runatlantis.io/docs/using-atlantis.md

Co-authored-by: PePe Amengual <[email protected]>

* chore(atlantis): add example

Signed-off-by: Abdulla Mulail Mohamed <[email protected]>

---------

Signed-off-by: Abdulla Mulail Mohamed <[email protected]>
Co-authored-by: PePe Amengual <[email protected]>
ijames-gc pushed a commit to gocardless/atlantis that referenced this pull request Feb 13, 2024
@leylmordor @jamengual @ijames-gc
docs(using-atlantis): add usage for -destroy flag in atlantis plan (r…
d1c0f3b 
…unatlantis#3755)

* docs(using-atlantis): add usage for -destroy flag in atlantis plan

Signed-off-by: Abdulla Mulail Mohamed <[email protected]>

* docs(using-atlantis): add closing to caution note

Signed-off-by: Abdulla Mulail Mohamed <[email protected]>

* Update runatlantis.io/docs/using-atlantis.md

Co-authored-by: PePe Amengual <[email protected]>

* Update runatlantis.io/docs/using-atlantis.md

Co-authored-by: PePe Amengual <[email protected]>

* chore(atlantis): add example

Signed-off-by: Abdulla Mulail Mohamed <[email protected]>

---------

Signed-off-by: Abdulla Mulail Mohamed <[email protected]>
Co-authored-by: PePe Amengual <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jamengual jamengual jamengual left review comments

@GenPage GenPage GenPage approved these changes

Assignees
No one assigned
Labels
docs Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@leylmordor @jamengual @GenPage