Merge pull request #434 from axodotdev/hide_generate_ci

chore(cli): hide generate-ci command
axodotdev · Sep 18, 2023 · 095cfcf · 095cfcf
2 parents 6bbdef4 + 44789e3
commit 095cfcf
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 36 deletions.
diff --git a/cargo-dist/src/cli.rs b/cargo-dist/src/cli.rs
@@ -126,6 +126,7 @@ pub enum Commands {
     Generate(GenerateArgs),
     /// Generate CI scripts for orchestrating cargo-dist (deprecated in favour of generate)
     #[clap(disable_version_flag = true)]
+    #[clap(hide = true)]
     GenerateCi(GenerateCiArgs),
     /// Generate the final build manifest without running any builds.
     ///

diff --git a/cargo-dist/tests/snapshots/long-help.snap b/cargo-dist/tests/snapshots/long-help.snap
@@ -11,13 +11,12 @@ Usage: cargo dist [OPTIONS]
        cargo dist <COMMAND>
 
 Commands:
-  build        Build artifacts
-  init         Setup or update cargo-dist
-  generate     Generate one or more pieces of configuration
-  generate-ci  Generate CI scripts for orchestrating cargo-dist (deprecated in favour of generate)
-  manifest     Generate the final build manifest without running any builds
-  plan         Get a plan of what to build (and check project status)
-  help         Print this message or the help of the given subcommand(s)
+  build     Build artifacts
+  init      Setup or update cargo-dist
+  generate  Generate one or more pieces of configuration
+  manifest  Generate the final build manifest without running any builds
+  plan      Get a plan of what to build (and check project status)
+  help      Print this message or the help of the given subcommand(s)
 
 Options:
   -h, --help

diff --git a/cargo-dist/tests/snapshots/markdown-help.snap b/cargo-dist/tests/snapshots/markdown-help.snap
@@ -22,7 +22,6 @@ cargo dist <COMMAND>
 * [build](#cargo-dist-build): Build artifacts
 * [init](#cargo-dist-init): Setup or update cargo-dist
 * [generate](#cargo-dist-generate): Generate one or more pieces of configuration
-* [generate-ci](#cargo-dist-generate-ci): Generate CI scripts for orchestrating cargo-dist (deprecated in favour of generate)
 * [manifest](#cargo-dist-manifest): Generate the final build manifest without running any builds
 * [plan](#cargo-dist-plan): Get a plan of what to build (and check project status)
 * [help](#cargo-dist-help): Print this message or the help of the given subcommand(s)
@@ -189,26 +188,6 @@ Print help (see a summary with '-h')
 ### GLOBAL OPTIONS
 This subcommand accepts all the [global options](#global-options)
 
-<br><br><br>
-## cargo dist generate-ci
-Generate CI scripts for orchestrating cargo-dist (deprecated in favour of generate)
-
-### Usage
-
-```text
-cargo dist generate-ci [OPTIONS]
-```
-
-### Options
-#### `--check`
-Check if the generated output differs from on-disk config without writing it
-
-#### `-h, --help`
-Print help (see a summary with '-h')
-
-### GLOBAL OPTIONS
-This subcommand accepts all the [global options](#global-options)
-
 <br><br><br>
 ## cargo dist manifest
 Generate the final build manifest without running any builds.
@@ -288,7 +267,6 @@ cargo dist help [COMMAND]
 * [build](#cargo-dist-build): Build artifacts
 * [init](#cargo-dist-init): Setup or update cargo-dist
 * [generate](#cargo-dist-generate): Generate one or more pieces of configuration
-* [generate-ci](#cargo-dist-generate-ci): Generate CI scripts for orchestrating cargo-dist (deprecated in favour of generate)
 * [manifest](#cargo-dist-manifest): Generate the final build manifest without running any builds
 * [plan](#cargo-dist-plan): Get a plan of what to build (and check project status)
 * [help](#cargo-dist-help): Print this message or the help of the given subcommand(s)

diff --git a/cargo-dist/tests/snapshots/short-help.snap b/cargo-dist/tests/snapshots/short-help.snap
@@ -9,13 +9,12 @@ Usage: cargo dist [OPTIONS]
        cargo dist <COMMAND>
 
 Commands:
-  build        Build artifacts
-  init         Setup or update cargo-dist
-  generate     Generate one or more pieces of configuration
-  generate-ci  Generate CI scripts for orchestrating cargo-dist (deprecated in favour of generate)
-  manifest     Generate the final build manifest without running any builds
-  plan         Get a plan of what to build (and check project status)
-  help         Print this message or the help of the given subcommand(s)
+  build     Build artifacts
+  init      Setup or update cargo-dist
+  generate  Generate one or more pieces of configuration
+  manifest  Generate the final build manifest without running any builds
+  plan      Get a plan of what to build (and check project status)
+  help      Print this message or the help of the given subcommand(s)
 
 Options:
   -h, --help     Print help (see more with '--help')