Clarify --restart-recipes flag behavior and change default to false

[hovu96]

Summary

The --restart-recipes flag allows restarting of running recipes that are updated during import, but does not force stopped recipes to restart. This was not clear from the help text and documentation, leading to confusion about the expected behavior.

Changes

• Breaking change: Changed default from true to false (more conservative approach)
• Updated help text to clarify that stopped recipes remain stopped
• Added inline comments in documentation (COMMAND_REFERENCE.md and USE_CASES.md)
• Updated test to reflect new default value

Behavior

Before: workato push would allow recipe restarts by default
After: workato push will NOT allow recipe restarts by default

Users who want to allow restarts must now explicitly use:

workato push --restart-recipes

This aligns with the Workato API's default behavior and makes the CLI more conservative by default.

Testing

• ✅ All unit tests pass
• ✅ Ruff linter passed
• ✅ Mypy type checker passed

🤖 Generated with Claude Code

[github-actions]

Coverage Report

File	Stmts	Miss	Cover	Missing
__init__.py	68	4	94%	10–11, 69–70
cli
__init__.py	52	3	94%	49, 51, 60
containers.py	27	0	100%
cli/commands
__init__.py	0	0	100%
api_clients.py	286	9	96%	24, 297, 442–443, 476, 486, 576, 607, 615
api_collections.py	253	3	98%	25, 178, 340
assets.py	46	2	95%	51–52
connections.py	520	5	99%	582, 584, 590, 628, 977
data_tables.py	163	5	96%	28, 248, 262, 316–317
guide.py	166	1	99%	106
init.py	89	0	100%
profiles.py	197	0	100%
properties.py	95	1	98%	18
pull.py	171	2	98%	190–191
workspace.py	38	2	94%	57, 67
cli/commands/connectors
__init__.py	0	0	100%
command.py	88	2	97%	105, 154
connector_manager.py	203	4	98%	176, 292, 300–301
cli/commands/projects
__init__.py	0	0	100%
command.py	269	10	96%	353–356, 367, 433–435, 485, 489
project_manager.py	166	7	95%	48, 66, 263–264, 276, 317, 325
cli/commands/push
__init__.py	0	0	100%
command.py	132	4	96%	105, 108, 226, 304
cli/commands/recipes
__init__.py	0	0	100%
command.py	423	9	97%	113, 129–130, 267–270, 397, 703
validator.py	706	20	97%	174, 883, 1136, 1223, 1246, 1279, 1281–1282, 1359–1361, 1457–1458, 1517–1518, 1707–1708, 1736–1738
cli/utils
__init__.py	3	0	100%
exception_handler.py	198	6	96%	137, 184, 211, 238, 295, 330
gitignore.py	14	0	100%
ignore_patterns.py	23	0	100%
spinner.py	43	0	100%
version_checker.py	135	6	95%	24, 26, 33–34, 72, 102
cli/utils/config
__init__.py	5	0	100%
manager.py	467	19	95%	125, 136–138, 141, 154, 204–205, 357, 438–439, 478, 692, 835–836, 850–851, 912, 971
models.py	33	0	100%
profiles.py	309	10	96%	93, 189–190, 193, 228–230, 255–257
workspace.py	68	0	100%
TOTAL	5456	134	97%

[Copilot]

Pull Request Overview

This PR changes the default behavior of the --restart-recipes flag in the push command from True to False, making recipe restart an opt-in feature rather than opt-out. The help text is also updated to clarify that the flag only allows restarting of running recipes that were updated, while stopped recipes remain stopped.

Key Changes

• Changed --restart-recipes default from True to False in the push command
• Updated help text to clarify that the flag allows restarting running recipes, and stopped recipes remain stopped
• Updated test expectations to align with the new default value
• Updated documentation to reflect the new default behavior and add clarifying comments

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File	Description
src/workato_platform_cli/cli/commands/push/command.py	Changed --restart-recipes default to False and updated help text to clarify behavior
tests/unit/commands/push/test_command.py	Updated test assertion to expect False as default value for restart_recipes
docs/USE_CASES.md	Added comments clarifying that --restart-recipes only restarts running recipes
docs/COMMAND_REFERENCE.md	Updated documentation to note recipes won't restart by default and clarified behavior; fixed trailing whitespace

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[oalami]

LGTM