docs: State that the meltano compile command is in beta (meltano#7322)

BuzzCutNorman · Feb 17, 2023 · c359864 · c359864
1 parent c5c2edb
commit c359864
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/docs/src/_reference/command-line-interface.md b/docs/src/_reference/command-line-interface.md
@@ -122,6 +122,10 @@ The `add` command does not run relative to a [Meltano Environment](https://docs.
 
 ## `compile`
 
+<div class="notification is-warning">
+    <p><a href="https://github.com/meltano/meltano/discussions/7323">The compile command is currently in beta</a>, and subject to change without corresponding semantic version updates.</p>
+</div>
+
 ### How to use
 
 Generally, the `compile` command need not be executed manually, as it will be run automatically by Meltano as-needed.

diff --git a/src/meltano/cli/compile.py b/src/meltano/cli/compile.py
@@ -18,8 +18,7 @@
 from meltano.core.tracking.contexts import CliEvent
 
 
-# FIXME: Should this command be named `manifest` instead of `compile`?
-@cli.command(cls=InstrumentedCmd, short_help="Compile a Meltano manifest.")
+@cli.command(cls=InstrumentedCmd, short_help="Compile a Meltano manifest. (beta)")
 @click.option(
     "--directory",
     default=".meltano/manifests",
@@ -57,8 +56,10 @@ def compile(  # noqa: WPS125
     """
     Compile a Meltano project into environment-specific manifest files.
 
+    This command is in beta, and subject to change without corresponding semantic version updates.
+
     \b\nRead more at https://docs.meltano.com/reference/command-line-interface#compile
-    """
+    """  # noqa: E501
     tracker: Tracker = ctx.obj["tracker"]
 
     try: