diff --git a/docs/maintainers/handbook.md b/docs/maintainers/handbook.md index 024305d..b00df0f 100644 --- a/docs/maintainers/handbook.md +++ b/docs/maintainers/handbook.md @@ -496,6 +496,10 @@ You can also add release notes for the next release into a special file `release This feature is only available in the >= 0.9.x series of `abra`. +## Can I hack on a local recipe ignoring any git or version state? + +Yes this is possible! Please have a look at [local recipes](/operators/handbook/#local-recipes) on how to specify a local recipe. + ## How do I know whether to accept version upgrades when running `abra recipe upgrade `? ### Postgres diff --git a/docs/operators/handbook.md b/docs/operators/handbook.md index 2057eef..7841b3a 100644 --- a/docs/operators/handbook.md +++ b/docs/operators/handbook.md @@ -558,6 +558,20 @@ will fetch the remote recipe and create a directory for it under `$ABRA_DIR` $ABRA_DIR/recipes/mygit_org_myorg_cool-recipe ``` +## Local recipes + +!!! warning "Watch out for old versions of `abra` 🚧" + + This feature is only available in the >= 0.13.x series of `abra`. + +It is possible to specify a local recipe in your `.env` file: + +``` +RECIPE=./recipes/my-local-recipe +``` + +This will look for the recipe in `$ABRA_DIR/`. Local recipe mode will ignore any git state and versioning and just take the recipe as it is. + ## Saving the version to the app `.env` file !!! warning "Watch out for old versions of `abra` 🚧"