feat(input): use the config file from given path

This commit is contained in:
orhun
2021-06-18 03:00:25 +03:00
parent 920cd73efd
commit 9e859999aa
4 changed files with 35 additions and 3 deletions

View File

@@ -11,6 +11,7 @@ jobs:
id: git-cliff
uses: ./
with:
config: fixtures/cliff.toml
args: --verbose
- name: Print the changelog
run: echo "${{ steps.git-cliff.outputs.changelog }}"

View File

@@ -6,7 +6,8 @@ This action generates a changelog based on your Git history using [git-cliff](ht
### Inputs
* `args`: Arguments to pass to git-cliff. Default `"-v"`
* `config`: Path of the configuration file. Default: `"cliff.toml"`
* `args`: Arguments to pass to git-cliff. Default: `"-v"`
### Outputs
@@ -18,6 +19,7 @@ This action generates a changelog based on your Git history using [git-cliff](ht
- name: Changelog Generator
uses: orhun/git-cliff-action@v1
with:
config: cliff.toml
args: --verbose
```

View File

@@ -1,18 +1,22 @@
name: "git-cliff: Changelog Generator"
description: "Generate changelog based on your Git history"
inputs:
config:
description: "config file location"
required: false
default: "cliff.toml"
args:
description: "git-cliff arguments"
required: false
default: "-v"
outputs:
changelog:
description: 'generated changelog'
description: "generated changelog"
runs:
using: "docker"
image: "Dockerfile"
args:
- ${{ inputs.args }}
- "-c ${{ inputs.config }} ${{ inputs.args }}"
branding:
icon: "triangle"
color: "orange"

25
fixtures/cliff.toml Normal file
View File

@@ -0,0 +1,25 @@
# configuration file for git-cliff (0.1.0)
[changelog]
header = "# Changelog\n"
body = """
{% if version %}\
## [{{ version | replace(from="v", to="") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
{% else %}\
## [unreleased]
{% endif %}\
{% for group, commits in commits | group_by(attribute="group") %}
### {{ group | upper_first }}
{% for group, commits in commits | group_by(attribute="scope") %}\
#### {{ group }}\
{% for commit in commits %}
- {{ commit.message | upper_first }}\
{% endfor %}
{% endfor %}\
{% endfor %}\n
"""
trim=true
footer = "<!-- generated by git-cliff -->\n"
[git]
conventional_commits = true