Skip to content

Commit

Permalink
chore: add verbose logging to git-cliff
Browse files Browse the repository at this point in the history
  • Loading branch information
nydragon committed May 24, 2024
1 parent 9876c63 commit b24265a
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .github/workflows/cd.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,10 @@ jobs:
uses: orhun/git-cliff-action@v3
with:
config: cliff.toml
args: -l --strip header
args: --current -vv --strip header
env:
OUTPUT: ${{ github.workspace }}-CHANGELOG.txt
run: cat ${{ github.workspace }}-CHANGELOG.txt

- name: Release
uses: softprops/action-gh-release@v2
Expand Down
41 changes: 41 additions & 0 deletions d
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
git-cliff 2.2.1
git-cliff contributors <[email protected]>
A highly customizable changelog generator ⛰️

Usage:
git-cliff [FLAGS] [OPTIONS] [--] [RANGE]

FLAGS:
-h, --help Prints help information
-V, --version Prints version information
-v, --verbose... Increases the logging verbosity
--bump Bumps the version for unreleased changes
--bumped-version Prints bumped version for unreleased changes
-l, --latest Processes the commits starting from the latest tag
--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
--no-exec Disables the external command execution
-x, --context Prints changelog context as JSON

OPTIONS:
-i, --init [<CONFIG>] Writes the default configuration file to cliff.toml
-c, --config <PATH> Sets the configuration file [env: GIT_CLIFF_CONFIG=] [default: cliff.toml]
-w, --workdir <PATH> Sets the working directory [env: GIT_CLIFF_WORKDIR=]
-r, --repository <PATH>... Sets the git repository [env: GIT_CLIFF_REPOSITORY=]
--include-path <PATTERN>... Sets the path to include related commits [env: GIT_CLIFF_INCLUDE_PATH=]
--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=]
--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=]
-o, --output [<PATH>] Writes output to the given file [env: GIT_CLIFF_OUTPUT=]
-t, --tag <TAG> Sets the tag for the latest version [env: GIT_CLIFF_TAG=]
-b, --body <TEMPLATE> Sets the template for the changelog body [env: GIT_CLIFF_TEMPLATE=]
-s, --strip <PART> Strips the given parts from the changelog [possible values: header, footer, all]
--sort <SORT> Sets sorting of the commits inside sections [default: oldest] [possible values: oldest, newest]
--github-token <TOKEN> Sets the GitHub API token [env: GITHUB_TOKEN]
--github-repo <OWNER/REPO> Sets the GitHub repository [env: GITHUB_REPO=]

ARGS:
[RANGE] Sets the commit range to process

0 comments on commit b24265a

Please sign in to comment.