wp-env: Add cleanup command and force flag #75045
Open
Conversation
This file contains hidden or 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
youknowriad
requested review from
ObliviousHarmony and
t-hamano
as code owners
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
youknowriad
added
[Type] Enhancement
|
Size Change: 0 B Total Size: 3 MB ℹ️ View Unchanged
|
Add a new `cleanup` command that removes environment-specific resources (containers, volumes, networks, and local files) while preserving Docker images for faster re-starts. This is useful for archiving sessions without the overhead of full teardown. Also add `--force` flag to both `destroy` and `cleanup` commands to skip the confirmation prompt, enabling non-interactive usage in scripts. - Add cleanup command module with confirmation prompt support - Add --force flag to destroy and cleanup commands - Add getCleanupWarningMessage() methods to Docker and Playground runtimes - Add cleanup() methods to Docker and Playground runtimes - Update CLI to register cleanup command and force flag - Add tests for destroy and cleanup command parsing with force flag - Update README with cleanup command reference and lifecycle scripts - Update CHANGELOG with new features Co-Authored-By: Claude Haiku 4.5 <[email protected]>
Rename the `clean` command to `reset` to avoid confusion with the new `cleanup` command. The `clean` command is now deprecated but still works as an alias with a warning message. - Add new `reset` command that resets WordPress databases - Deprecate `clean` command (shows warning, still calls afterClean for backwards compat) - Update runtime messages to use "Resetting/Reset" instead of "Cleaning/Cleaned" - Add `afterReset` lifecycle script (afterClean still works for deprecated clean command) - Update README and CHANGELOG with deprecation notice Co-Authored-By: Claude Opus 4.5 <[email protected]>
youknowriad
force-pushed
the
wp-env-cleanup-command
branch
from
f8cf051 to
3ba970c
Compare
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.
What?
Add a new
cleanupcommand that removes environment-specific resources while preserving Docker images. Also add--forceflag to bothdestroyandcleanupcommands to skip confirmation prompts.Why?
In a world of worktrees, AI and parallel sessions, this command becomes necessary. When archiving sessions or running wp-env in non-interactive scripts, users need a way to clean up environments without removing shared Docker images (which can be large and time-consuming to rebuild). The
--forceflag enables automation without interactive prompts.How?
cleanupcommand: removes containers, volumes, networks, and local files but preserves Docker images (omits--rmi all)--forceflag: skips confirmation prompt on both commandsgetCleanupWarningMessage()andcleanup()for Docker and PlaygroundTesting Instructions
npx wp-env cleanupto test cleanup with confirmation promptnpx wp-env cleanup --forceto skip confirmationdocker images | grep wordpressnpx wp-env destroy --forceremoves everything including images🤖 Generated with Claude Code