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

refactor(docs): move --cleanup option into docs:prune command #644

Merged
merged 9 commits into from
Oct 27, 2022

Conversation

kanadgupta
Copy link
Member

@kanadgupta kanadgupta commented Oct 26, 2022

🚥 Fix RM-5580

🧰 Changes

Separates the --cleanup option on the docs command into a separate command called docs:prune. The docs command logic was getting confusing and it feels like an entirely separate use-case that is worthy of a separate command. This entire command is wrapped in a prompt now so the user must say "yes" before continuing with the pruning.

🧬 QA & Testing

Do the changes look good? And do tests pass?

@kanadgupta kanadgupta requested a review from erunion October 26, 2022 23:03
@kanadgupta kanadgupta added enhancement New feature or request refactor Issues about tackling technical debt command:docs Issues pertaining to the `docs`, `changelogs`, or `custompages` commands labels Oct 26, 2022
@kanadgupta kanadgupta marked this pull request as ready for review October 26, 2022 23:04
src/cmds/docs/cleanup.ts Outdated Show resolved Hide resolved
@@ -30,7 +30,7 @@ export default class EditDocsCommand extends Command {
this.usage = 'docs:edit <slug> [options]';
Copy link
Member

Choose a reason for hiding this comment

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

Honestly not opposed to deprecating this command now and removing it in v9.

Copy link
Member Author

@kanadgupta kanadgupta Oct 27, 2022

Choose a reason for hiding this comment

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

agree, will do in a separate PR!1

edit: see #646

Footnotes

  1. ticketed in RM-5649

src/cmds/docs/cleanup.ts Outdated Show resolved Hide resolved
@kanadgupta kanadgupta force-pushed the kanad/rm-5598-migrate-docs---cleanup-option-into-a branch from f214f0d to 7f60562 Compare October 27, 2022 13:40
@kanadgupta kanadgupta changed the base branch from kanad/rm-5580-consolidate-docs-and-docssingle to main October 27, 2022 13:40
@kanadgupta kanadgupta requested a review from erunion October 27, 2022 14:06
@kanadgupta
Copy link
Member Author

@shaiarmis FYI!

@kanadgupta kanadgupta added this to the v8 milestone Oct 27, 2022
@kanadgupta kanadgupta changed the title refactor(docs): move cleanup into separate command refactor(docs): move --cleanup option into docs:prune command Oct 27, 2022
@kanadgupta kanadgupta merged commit 4bc98c5 into main Oct 27, 2022
@kanadgupta kanadgupta deleted the kanad/rm-5598-migrate-docs---cleanup-option-into-a branch October 27, 2022 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
command:docs Issues pertaining to the `docs`, `changelogs`, or `custompages` commands enhancement New feature or request refactor Issues about tackling technical debt
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants