orhun/git-cliff
1
1
Fork 0
mirror of https://github.com/orhun/git-cliff.git synced 2024-09-11 15:05:30 +03:00
Code Issues Projects Releases Wiki Activity

docs: update args

Browse Source
This commit is contained in:
Meitar 2024-06-21 16:13:49 +03:00
parent cea95ad214
commit bd79b2230c
1 changed files with 26 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
website/docs/usage/args.md
View File

@ -20,8 +20,8 @@ git-cliff [FLAGS] [OPTIONS] [--] [RANGE]
--current Processes the commits that belong to the current tag
-u, --unreleased Processes the commits that do not belong to a tag
--topo-order Sorts the tags topologically
-x, --context Prints changelog context as JSON
--no-exec Disables the external command execution
-x, --context Prints changelog context as JSON
```
## Options
@ -35,6 +35,7 @@ git-cliff [FLAGS] [OPTIONS] [--] [RANGE]
--exclude-path <PATTERN>... Sets the path to exclude related commits [env: GIT_CLIFF_EXCLUDE_PATH=]
--tag-pattern <PATTERN> Sets the regex for matching git tags [env: GIT_CLIFF_TAG_PATTERN=]
--with-commit <MSG>... Sets custom commit messages to include in the changelog [env: GIT_CLIFF_WITH_COMMIT=]
--with-tag-message [<MSG>] Sets custom message to the latest release (will overwrite original tag's message if exists) [env: GIT_CLIFF_WITH_TAG_MESSAGE=]
--ignore-tags <PATTERN> Sets the tags to ignore in the changelog [env: GIT_CLIFF_IGNORE_TAGS=]
--skip-commit <SHA1>... Sets commits that will be skipped in the changelog [env: GIT_CLIFF_SKIP_COMMIT=]
-p, --prepend <PATH> Prepends entries to the given changelog file [env: GIT_CLIFF_PREPEND=]
@ -47,6 +48,10 @@ git-cliff [FLAGS] [OPTIONS] [--] [RANGE]
--github-repo <OWNER/REPO> Sets the GitHub repository [env: GITHUB_REPO=]
--gitlab-token <TOKEN> Sets the GitLab API token [env: GITLAB_TOKEN]
--gitlab-repo <OWNER/REPO> Sets the GitLab repository [env: GITLAB_REPO=]
--gitea-token <TOKEN> Sets the Gitea API token [env: GITEA_TOKEN]
--gitea-repo <OWNER/REPO> Sets the GitLab repository [env: GITEA_REPO=]
--bitbucket-token <TOKEN> Sets the Bitbucket API token [env: BITBUCKET_TOKEN]
--bitbucket-repo <OWNER/REPO> Sets the Bitbucket repository [env: BITBUCKET_REPO=]
```
## Args