garden
garden copied to clipboard
improvement(sync): purely interactive `sync start` and `stop` commands
BREAKING CHANGE
What this PR does / why we need it:
This PR removes the ability. to run garden sync start
and garden sync stop
outside the dev console.
- Command
sync start
now automatically starts the dev console likedeploy --sync
does. - Flag
--monitor
of thesync start
command has no effect and is marked as removed. - Command
sync stop
aborts with a warning message if it's started from outside the dev console.
These changes will allow us to fix the existing issues with the syncing resource management, and make the underlying Mutagen processed managed by Garden.
Technically, it is a breaking change. But it should not affect UX too much.
Special notes for your reviewer:
Changes in the lifecycle management of the Mutagen daemon and sync monitors will be done in a separate PR as a fix.
As discussed elsewhere, this is a direction we want to move to but we can't make a breaking change in a patch release. People might e.g. depend on this in scripts and not having the command exit would break those scripts.
Instead we should log a warning telling users that this behaviour is deprecated and will be changed in a future breaking change release. Instead we recommend running garden deploy --sync
or starting syncs inside the dev console with either deploy --sync
or sync start
.
Thanks @eysi09! I've created a PR with deprecation warnings, see #5747.
Closing this for now. We can re-open this later.