docs: --chaos/-C handling for catalogue generate

This commit is contained in:
decentral1se 2025-01-05 16:46:20 +01:00
parent c88fc66c99
commit 273c165a41
Signed by: decentral1se
GPG Key ID: 03789458B3D0C410
2 changed files with 5 additions and 3 deletions

View File

@ -25,6 +25,11 @@ var CatalogueGenerateCommand = &cobra.Command{
Short: "Generate the recipe catalogue", Short: "Generate the recipe catalogue",
Long: `Generate a new copy of 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 It is possible to generate new metadata for a single recipe by passing
[recipe]. The existing local catalogue will be updated, not overwritten. [recipe]. The existing local catalogue will be updated, not overwritten.

View File

@ -37,9 +37,6 @@ setup(){
run $ABRA catalogue generate gitea --chaos run $ABRA catalogue generate gitea --chaos
assert_success assert_success
assert_exists "$ABRA_DIR/recipes/$TEST_RECIPE/foo"
assert_equal "$(_git_status)" "?? foo"
run rm -rf "$ABRA_DIR/catalogue/foo" run rm -rf "$ABRA_DIR/catalogue/foo"
assert_not_exists "$ABRA_DIR/catalogue/foo" assert_not_exists "$ABRA_DIR/catalogue/foo"
} }