Skip to content

Commit

Permalink
feat: add cliff to produce changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
cafadev committed Sep 4, 2023
1 parent 0dbeedd commit b8a5c3d
Show file tree
Hide file tree
Showing 4 changed files with 152 additions and 6 deletions.
11 changes: 5 additions & 6 deletions .github/workflows/prerelease.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,13 @@ jobs:
id: toTag
uses: "WyriHaximus/github-action-get-previous-tag@v1"

- name: Run git-cliff
run: |
CHANGELOG=$(git cliff)
- name: Create Release
uses: softprops/action-gh-release@v1
with:
body: $CHANGELOG
prerelease: true
tag_name: ${{ steps.toTag.outputs.tag }}

- uses: BobAnkh/auto-generate-changelog@v1.2.5
id: changelog
with:
ACCESS_TOKEN: ${{secrets.GITHUB_TOKEN}}
TYPE: 'feat:Feature,fix:Bug Fixes,docs:Documentation,refactor:Refactor,perf:Performance Improvements'
36 changes: 36 additions & 0 deletions CHANGELOG.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Changelog

All notable changes to this project will be documented in this file.

## [unreleased]

### Bug Fixes

- Remove dagger from ci process
- Update versioning for breaking changes
- Add full history on workflow

## [1.0.0-alpha.1] - 2023-09-04

### Bug Fixes

- Remove unnecesary steps
- Remove extra step

### Features

- Initial project status
- Add ci flow with dagger
- Add github workflow
- Add dependency
- Activate poetry environment
- Remove shell activation
- Save new tag version on remote
- Add workflow for prereleases
- Add workflow for prereleases
- Catch latest tag
- Catch latest tag
- Generate release
- Generate release

<!-- generated by git-cliff -->
36 changes: 36 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Changelog

All notable changes to this project will be documented in this file.

## [1.0.0-alpha.2] - 2023-09-04

### Bug Fixes

- Remove dagger from ci process
- Update versioning for breaking changes
- Add full history on workflow

## [1.0.0-alpha.1] - 2023-09-04

### Bug Fixes

- Remove unnecesary steps
- Remove extra step

### Features

- Initial project status
- Add ci flow with dagger
- Add github workflow
- Add dependency
- Activate poetry environment
- Remove shell activation
- Save new tag version on remote
- Add workflow for prereleases
- Add workflow for prereleases
- Catch latest tag
- Catch latest tag
- Generate release
- Generate release

<!-- generated by git-cliff -->
75 changes: 75 additions & 0 deletions cliff.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# git-cliff ~ default configuration file
# https://git-cliff.org/docs/configuration
#
# Lines starting with "#" are comments.
# Configuration options are organized into tables and keys.
# See documentation for more information on available options.

[changelog]
# changelog header
header = """
# Changelog\n
All notable changes to this project will be documented in this file.\n
"""
# template for the changelog body
# https://tera.netlify.app/docs
body = """
{% if version %}\
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
{% else %}\
## [unreleased]
{% endif %}\
{% for group, commits in commits | group_by(attribute="group") %}
### {{ group | upper_first }}
{% for commit in commits %}
- {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\
{% endfor %}
{% endfor %}\n
"""
# remove the leading and trailing whitespace from the template
trim = true
# changelog footer
footer = """
<!-- generated by git-cliff -->
"""

[git]
# parse the commits based on https://www.conventionalcommits.org
conventional_commits = true
# filter out the commits that are not conventional
filter_unconventional = true
# process each line of a commit as an individual commit
split_commits = false
# regex for preprocessing the commit messages
commit_preprocessors = [
# { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/orhun/git-cliff/issues/${2}))"}, # replace issue numbers
]
# regex for parsing and grouping commits
commit_parsers = [
{ message = "^feat", group = "Features" },
{ message = "^fix", group = "Bug Fixes" },
{ message = "^doc", group = "Documentation" },
{ message = "^perf", group = "Performance" },
{ message = "^refactor", group = "Refactor" },
{ message = "^style", group = "Styling" },
{ message = "^test", group = "Testing" },
{ message = "^chore\\(release\\): prepare for", skip = true },
{ message = "^chore", group = "Miscellaneous Tasks" },
{ body = ".*security", group = "Security" },
]
# protect breaking changes from being skipped due to matching a skipping commit_parser
protect_breaking_commits = false
# filter out the commits that are not matched by commit parsers
filter_commits = false
# glob pattern for matching git tags
tag_pattern = "v[0-9]*"
# regex for skipping tags
skip_tags = "v0.1.0-beta.1"
# regex for ignoring tags
ignore_tags = ""
# sort the tags topologically
topo_order = false
# sort the commits inside sections by oldest/newest order
sort_commits = "oldest"
# limit the number of commits included in the changelog.
# limit_commits = 42

0 comments on commit b8a5c3d

Please sign in to comment.