This is a forked version of ardalanamin/auto-changelog.
-
Generates change logs between the latest two version tags, regardless of the sha of the commit which triggers the action.
- version tags: semver string starting with
v
(e.g.v1.2.3
)
- version tags: semver string starting with
-
Added a release timestamp (e.g.
2021-03-12 AM09:54:54
in KST) -
Added a link to diff between the latest two tags
-
Added a little decoration
- Added
change
type - Added some emoji
- Added
uses: ryan-cha/auto-changelog-between-tags@latest
with:
token: ${{ secrets.GITHUB_TOKEN }}
exclude: "perf,other,breaking"
Automatic Changelog generator
To use this action, your commit messages have to follow the format below:
type(category): description [flag]
The type
must be one of the followings:
breaking
(Breaking Changes)build
(Build System / Dependencies)ci
(Continuous Integration)chore
(Chores)docs
(Documentation Changes)feat
(New Features)fix
(Bug Fixes)other
(Other Changes)perf
(Performance Improvements)refactor
(Refactors)revert
(Reverts)style
(Code Style Changes)test
(Tests)
If the
type
is not found in the list, it'll be considered asother
.
The category
is optional and can be anything of your choice.
The flag
is optional (if provided, it must be surrounded in square brackets) and can be one of the followings:
ignore
(Omits the commit from the changelog)
If
flag
is not found in the list, it'll be ignored.
Github token.
Exclude selected commit types (comma separated).
The generated changelog.
uses: ardalanamini/auto-changelog@v1.1.0
with:
token: ${{ secrets.GITHUB_TOKEN }}
exclude: "perf,other,breaking"