From ec858d1af9f7b109c20ffa0780031f4d3db08999 Mon Sep 17 00:00:00 2001 From: Mazel Date: Wed, 24 May 2023 12:49:31 +0200 Subject: [PATCH] docs: add documentation about `--push` flag (#114) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c926a46..86ab0bf 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ npx changelogen@latest [...args] [--dir ] - `--dir`: Path to git repository. When not provided, **current working directory** will be used as as default. - `--output`: Changelog file name to create or update. Defaults to `CHANGELOG.md` and resolved relative to dir. Use `--no-output` to write to console only. - `--bump`: Determine semver change and update version in `package.json`. -- `--release`. Bumps version in `package.json` and creates commit and git tags using local `git`. You can disable commit using `--no-commit` and tag using `--no-tag`. +- `--release`. Bumps version in `package.json` and creates commit and git tags using local `git`. You can disable commit using `--no-commit` and tag using `--no-tag`. You can enable the automatic push of the new tag and release commit to your git repository by adding `--push`. - `-r`: Release as specific version. - `--major`: Bump as a semver-major version - `--minor`: Bump as a semver-minor version