From ea11a0d51fa139cfb1d46af5e9759e6137647a4b Mon Sep 17 00:00:00 2001 From: Lars Kappert Date: Sat, 9 Apr 2022 10:13:35 -0300 Subject: [PATCH] Add comment re. quoting CLI hook arguments (closes #865) --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 72dc7c2f..70ec8c7c 100644 --- a/README.md +++ b/README.md @@ -271,6 +271,12 @@ Use `--verbose` to log the output of the commands. For the sake of verbosity, the full list of hooks is actually: `init`, `beforeBump`, `bump`, `beforeRelease`, `release` or `afterRelease`. However, hooks like `before:beforeRelease` look weird and are usually not useful in practice. +Note that arguments need to be quoted properly when used from the command line: + +```bash +release-it --'hooks.after:release="echo Successfully released ${name} v${version} to ${repo.repository}."' +``` + ## Plugins Since v11, release-it can be extended in many, many ways. Here are some plugins: