From 273c165a41e750903723f611ac94f6cff360a0e6 Mon Sep 17 00:00:00 2001 From: decentral1se Date: Sun, 5 Jan 2025 16:46:20 +0100 Subject: [PATCH] docs: --chaos/-C handling for catalogue generate --- cli/catalogue/catalogue.go | 5 +++++ tests/integration/catalogue.bats | 3 --- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/cli/catalogue/catalogue.go b/cli/catalogue/catalogue.go index 5bbed464..9c7abd27 100644 --- a/cli/catalogue/catalogue.go +++ b/cli/catalogue/catalogue.go @@ -25,6 +25,11 @@ var CatalogueGenerateCommand = &cobra.Command{ Short: "Generate the recipe catalogue", Long: `Generate a new copy of the recipe catalogue. +N.B. this command **will** wipe local unstaged changes from your local recipes +if present. "--chaos/-C" on this command refers to the catalogue repository +("$ABRA_DIR/catalogue") and not the recipes. Please take care not to lose your +changes. + It is possible to generate new metadata for a single recipe by passing [recipe]. The existing local catalogue will be updated, not overwritten. diff --git a/tests/integration/catalogue.bats b/tests/integration/catalogue.bats index a907bc9d..0d4c25f7 100644 --- a/tests/integration/catalogue.bats +++ b/tests/integration/catalogue.bats @@ -37,9 +37,6 @@ setup(){ run $ABRA catalogue generate gitea --chaos assert_success - assert_exists "$ABRA_DIR/recipes/$TEST_RECIPE/foo" - assert_equal "$(_git_status)" "?? foo" - run rm -rf "$ABRA_DIR/catalogue/foo" assert_not_exists "$ABRA_DIR/catalogue/foo" }