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.

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

fix: docs for clean flag #318

Merged
merged 2 commits into from
Apr 29, 2022
Merged

fix: docs for clean flag #318

merged 2 commits into from
Apr 29, 2022

Conversation

mshanemc
Copy link
Contributor

What does this PR do?

clarify that org:list --clean only deletes expired scratch orgs

What issues does this PR fix or reference?

forcedotcom/cli#1449

@W-10886099@

@cromwellryan
Copy link
Member

cromwellryan commented Apr 28, 2022

This definitely narrows and clarifies the scope of what --clean affects.

The other side of the coin 🪙 is helping the user understand how to deal with the other entries their trying to "clean" up. @jclark-dot-org describes that here:

I would suggest that if you clarify the docs for --clean as only affecting scratch orgs, you mention in the same place that auth:logout is the right way to remove non-scratch orgs.

What would happen if we appended something like:

remove all local org authorizations for non-active scratch orgs. auth:logout can be used to remove non-scratch orgs

@mshanemc mshanemc merged commit 123eb33 into main Apr 29, 2022
@mshanemc mshanemc deleted the sm/list-clean-docs branch April 29, 2022 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants