Chore: Rename --promote-all to --include-unmodified (#1166)

Author: izeigerman

docs/reference/configuration.md

@@ -149,7 +149,7 @@ See [Airflow Integration Guide](../integrations/airflow.md) for information on h
 | `snapshot_ttl`            | The period of time that a model snapshot not a part of any environment should exist before being deleted. This is defined as a string with the default `in 1 week`. Other [relative dates](https://dateparser.readthedocs.io/en/latest/) can be used, such as `in 30 days`. (Default: `in 1 week`) | string               | N        |
 | `environment_ttl`         | The period of time that a development environment should exist before being deleted. This is defined as a string with the default `in 1 week`. Other [relative dates](https://dateparser.readthedocs.io/en/latest/) can be used, such as `in 30 days`. (Default: `in 1 week`)                      | string               | N        |
 | `pinned_environments`     | The list of development environments that are exempt from deletion due to expiration                                                                                                                                                                                                               | list[string]         | N        |
-| `promote_all`             | Indicates whether to create views for all models in the target development environment or only for modified ones                                                                                                                                                                                   | boolean              | N        |
+| `include_unmodified`      | Indicates whether to create views for all models in the target development environment or only for modified ones                                                                                                                                                                                   | boolean              | N        |
 | `ignore_patterns`         | Files that match glob patterns specified in this list are ignored when scanning the project folder (Default: `[]`)                                                                                                                                                                                 | list[string]         | N        |
 | `time_column_format`      | The default format to use for all model time columns. This time format uses [python format codes](https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes) (Default: `%Y-%m-%d`)                                                                                        | string               | N        |
 | `auto_categorize_changes` | Indicates whether SQLMesh should attempt to automatically [categorize](../concepts/plans.md#change-categories) model changes during plan creation per each model source type ([Additional Details](#auto-categorize-changes))                                                                      | dict[string, string] | N        |

sqlmesh/cli/main.py

@@ -267,9 +267,9 @@ def diff(ctx: click.Context, environment: t.Optional[str] = None) -> None:
     default=None,
 )
 @click.option(
-    "--promote-all",
+    "--include-unmodified",
     is_flag=True,
-    help="Promote all models in the target environment as opposed to only modified ones.",
+    help="Include unmodified models in the target environment.",
     default=None,
 )
 @click.pass_context

sqlmesh/core/config/root.py

@@ -39,7 +39,7 @@ class Config(BaseConfig):
         users: A list of users that can be used for approvals/notifications.
         pinned_environments: A list of development environment names that should not be deleted by the janitor task.
         model_defaults: Default values for model definitions.
-        promote_all: Indicates whether to promote all models in the target development environment or only modified ones.
+        include_unmodified: Indicates whether to include unmodified models in the target development environment.
     """
 
     gateways: t.Union[t.Dict[str, GatewayConfig], GatewayConfig] = GatewayConfig()
@@ -60,7 +60,7 @@ class Config(BaseConfig):
     loader: t.Type[Loader] = SqlMeshLoader
     env_vars: t.Dict[str, str] = {}
     username: str = ""
-    promote_all: bool = False
+    include_unmodified: bool = False
 
     _FIELD_UPDATE_STRATEGY: t.ClassVar[t.Dict[str, UpdateStrategy]] = {
         "gateways": UpdateStrategy.KEY_UPDATE,

sqlmesh/core/context.py

@@ -683,7 +683,7 @@ def plan(
         auto_apply: bool = False,
         no_auto_categorization: t.Optional[bool] = None,
         effective_from: t.Optional[TimeLike] = None,
-        promote_all: t.Optional[bool] = None,
+        include_unmodified: t.Optional[bool] = None,
     ) -> Plan:
         """Interactively create a migration plan.
 
@@ -717,7 +717,7 @@ def plan(
                 changes (breaking / non-breaking). If not provided, then the corresponding configuration
                 option determines the behavior.
             effective_from: The effective date from which to apply forward-only changes on production.
-            promote_all: Indicates whether to promote all models in the target development environment or only modified ones.
+            include_unmodified: Indicates whether to include unmodified models in the target development environment.
 
         Returns:
             The populated Plan object.
@@ -736,8 +736,8 @@ def plan(
             self.environment_ttl if environment not in self.pinned_environments else None
         )
 
-        if promote_all is None:
-            promote_all = self.config.promote_all
+        if include_unmodified is None:
+            include_unmodified = self.config.include_unmodified
 
         plan = Plan(
             context_diff=self._context_diff(environment or c.PROD, create_from=create_from),
@@ -754,7 +754,7 @@ def plan(
             categorizer_config=self.auto_categorize_changes,
             auto_categorization_enabled=not no_auto_categorization,
             effective_from=effective_from,
-            promote_all=promote_all,
+            include_unmodified=include_unmodified,
         )
 
         if not no_prompts:

sqlmesh/core/plan/definition.py

@@ -63,7 +63,7 @@ class Plan:
         categorizer_config: Auto categorization settings.
         auto_categorization_enabled: Whether to apply auto categorization.
         effective_from: The effective date from which to apply forward-only changes on production.
-        promote_all: Indicates whether to promote all models in the target development environment or only modified ones.
+        include_unmodified: Indicates whether to include unmodified models in the target development environment.
     """
 
     def __init__(
@@ -82,7 +82,7 @@ def __init__(
         categorizer_config: t.Optional[CategorizerConfig] = None,
         auto_categorization_enabled: bool = True,
         effective_from: t.Optional[TimeLike] = None,
-        promote_all: bool = False,
+        include_unmodified: bool = False,
     ):
         self.context_diff = context_diff
         self.override_start = start is not None
@@ -95,7 +95,7 @@ def __init__(
         self.environment_ttl = environment_ttl
         self.categorizer_config = categorizer_config or CategorizerConfig()
         self.auto_categorization_enabled = auto_categorization_enabled
-        self.promote_all = promote_all
+        self.include_unmodified = include_unmodified
         self._effective_from: t.Optional[TimeLike] = None
         self._start = start if start or not (is_dev and forward_only) else yesterday_ds()
         self._end = end if end or not is_dev else now()
@@ -269,7 +269,7 @@ def environment(self) -> Environment:
 
         snapshots = [s.table_info for s in self.snapshots]
         promoted_snapshot_ids = None
-        if self.is_dev and not self.promote_all:
+        if self.is_dev and not self.include_unmodified:
             promoted_snapshot_ids = [
                 s.snapshot_id for s in snapshots if s.name in self.context_diff.promotable_models
             ]
@@ -628,12 +628,12 @@ def _ensure_forward_only_models_compatibility(self) -> None:
     def _ensure_new_env_with_changes(self) -> None:
         if (
             self.is_dev
-            and not self.promote_all
+            and not self.include_unmodified
             and self.context_diff.is_new_environment
             and not self.context_diff.has_snapshot_changes
         ):
             raise NoChangesPlanError(
-                "No changes were detected. Make a change or run with --promote-all to create a new environment without changes."
+                "No changes were detected. Make a change or run with --include-unmodified to create a new environment without changes."
             )
 
 

sqlmesh/magics.py

@@ -292,9 +292,9 @@ def test(self, line: str, test_def_raw: t.Optional[str] = None) -> None:
         default=None,
     )
     @argument(
-        "--promote-all",
+        "--include-unmodified",
         action="store_true",
-        help="Promote all models in the target environment as opposed to only modified ones.",
+        help="Include unmodified models in the target environment.",
         default=None,
     )
     @line_magic
@@ -322,7 +322,7 @@ def plan(self, line: str) -> None:
             auto_apply=args.auto_apply,
             no_auto_categorization=args.no_auto_categorization,
             effective_from=args.effective_from,
-            promote_all=args.promote_all,
+            include_unmodified=args.include_unmodified,
         )
         self._context.console = console
 

tests/core/test_context.py

@@ -287,7 +287,7 @@ def test_plan_apply(sushi_context) -> None:
         "dev",
         start=yesterday_ds(),
         end=yesterday_ds(),
-        promote_all=True,
+        include_unmodified=True,
     )
     sushi_context.apply(plan)
     assert sushi_context.state_reader.get_environment("dev")

tests/core/test_integration.py

@@ -735,7 +735,7 @@ def apply_to_environment(
         environment,
         forward_only=choice == SnapshotChangeCategory.FORWARD_ONLY,
         no_prompts=True,
-        promote_all=True,
+        include_unmodified=True,
     )
     plan.set_start(start(context))
 

tests/core/test_plan.py

@@ -506,7 +506,9 @@ def test_new_environment_no_changes(make_snapshot, mocker: MockerFixture):
 
     assert Plan(context_diff_mock).environment.promoted_snapshot_ids is None
     assert (
-        Plan(context_diff_mock, is_dev=True, promote_all=True).environment.promoted_snapshot_ids
+        Plan(
+            context_diff_mock, is_dev=True, include_unmodified=True
+        ).environment.promoted_snapshot_ids
         is None
     )
 

tests/core/test_plan_evaluator.py

@@ -18,7 +18,7 @@ def sushi_plan(sushi_context: Context, mocker: MockerFixture) -> Plan:
     return Plan(
         sushi_context._context_diff("dev"),
         is_dev=True,
-        promote_all=True,
+        include_unmodified=True,
     )