Skip to content

Commit

Permalink
docs(changelog): add git-cliff
Browse files Browse the repository at this point in the history
 - add CHANGELOG.md
  • Loading branch information
ryanvade committed Jul 13, 2024
1 parent 60607ef commit 6015f7a
Show file tree
Hide file tree
Showing 2 changed files with 208 additions and 0 deletions.
126 changes: 126 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
# Changelog

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

## [1.1.2] - 2024-07-09

### Miscellaneous Tasks

- *(deps)* Bump @types/node from 20.11.25 to 20.11.28 (#71)
- *(deps)* Bump @octokit/webhooks from 13.1.0 to 13.1.1 (#69)
- *(deps)* Bump @types/node from 20.11.28 to 20.11.30 (#75)
- *(deps)* Bump typescript from 5.4.2 to 5.4.3 (#74)
- *(deps)* Bump undici from 5.28.3 to 5.28.4 (#79)
- *(deps)* Bump @types/node from 20.11.30 to 20.12.2 (#77)
- *(deps)* Bump typescript from 5.4.3 to 5.4.4 (#81)
- *(deps)* Bump @types/node from 20.12.2 to 20.12.5 (#83)
- *(deps)* Bump @octokit/webhooks from 13.1.1 to 13.2.2 (#84)
- *(deps)* Bump @octokit/webhooks from 13.2.2 to 13.2.7 (#101)
- *(deps)* Bump eslint-plugin-jest from 27.9.0 to 28.6.0 (#113)
- *(deps)* Bump braces from 3.0.2 to 3.0.3 (#115)
- *(deps)* Bump @types/node from 20.12.5 to 20.14.9 (#121)
- *(deps)* Bump typescript from 5.4.4 to 5.5.2 (#123)
- *(deps)* Bump eslint-plugin-github from 4.10.2 to 5.0.1 (#125)
- *(deps)* Bump prettier from 3.2.5 to 3.3.2 (#127)
- *(deps)* Bump ts-jest from 29.1.2 to 29.1.5 (#124)
- *(deps)* Bump @types/node from 20.14.9 to 20.14.10 (#131)
- *(deps)* Bump typescript from 5.5.2 to 5.5.3 (#130)
- *(deps-dev)* Bump @typescript-eslint/parser from 7.1.1 to 7.2.0 (#70)
- *(deps-dev)* Bump @typescript-eslint/eslint-plugin (#72)
- *(deps-dev)* Bump @typescript-eslint/parser from 7.2.0 to 7.3.1 (#73)
- *(deps-dev)* Bump @typescript-eslint/eslint-plugin (#78)
- *(deps-dev)* Bump @typescript-eslint/parser from 7.3.1 to 7.5.0 (#80)
- *(deps-dev)* Bump @typescript-eslint/eslint-plugin (#82)
- *(deps-dev)* Bump @typescript-eslint/parser from 7.5.0 to 7.13.1 (#119)
- *(deps-dev)* Bump @typescript-eslint/eslint-plugin from 7.5.0 to 7.14.1 (#122)
- *(deps-dev)* Bump @typescript-eslint/parser from 7.13.1 to 7.14.1 (#126)
- *(deps-dev)* Bump @typescript-eslint/parser from 7.14.1 to 7.15.0 (#128)
- *(deps-dev)* Bump @typescript-eslint/eslint-plugin (#132)


### Build

- *(No Category)* Release v1.1.2 (#133)


## [1.1] - 2024-03-10

### Documentation

- *(No Category)* Bump version to 1.1


### Miscellaneous Tasks

- *(dependabot)* Move dependabot config file
- *(deps)* Bump @types/node from 20.10.0 to 20.10.3 (#9)
- *(deps)* Bump @octokit/webhooks from 12.0.8 to 12.0.10 (#10)
- *(deps)* Bump @types/node from 20.10.3 to 20.10.4 (#14)
- *(deps)* Bump typescript from 5.3.2 to 5.3.3 (#15)
- *(deps)* Bump @types/jest from 29.5.10 to 29.5.11 (#17)
- *(deps)* Bump prettier from 3.1.0 to 3.1.1 (#16)
- *(deps)* Bump @types/node from 20.10.4 to 20.10.5
- *(deps)* Bump @types/node from 20.10.5 to 20.10.6 (#25)
- *(deps)* Bump @octokit/webhooks from 12.0.10 to 12.0.11 (#31)
- *(deps)* Bump eslint-plugin-jest from 27.6.0 to 27.6.3 (#35)
- *(deps)* Bump @types/node from 20.10.6 to 20.11.6 (#40)
- *(deps)* Bump ts-jest from 29.1.1 to 29.1.2 (#43)
- *(deps)* Bump @types/node from 20.11.6 to 20.11.16 (#48)
- *(deps)* Bump prettier from 3.1.1 to 3.2.5 (#46)
- *(deps)* Bump @types/jest from 29.5.11 to 29.5.12 (#51)
- *(deps)* Bump @octokit/webhooks from 12.0.11 to 12.1.0 (#52)
- *(deps)* Bump @types/node from 20.11.16 to 20.11.17 (#54)
- *(deps)* Bump undici from 5.28.0 to 5.28.3 (#55)
- *(deps)* Bump eslint-plugin-jest from 27.6.3 to 27.9.0 (#59)
- *(deps)* Bump @octokit/webhooks from 12.1.0 to 13.0.1 (#60)
- *(deps)* Bump @types/node from 20.11.17 to 20.11.20 (#61)
- *(deps)* Bump @types/node from 20.11.17 to 20.11.24 (#62)
- *(deps)* Bump eslint-plugin-github from 4.10.1 to 4.10.2 (#66)
- *(deps)* Bump @octokit/webhooks from 13.0.1 to 13.1.0 (#63)
- *(deps-dev)* Bump eslint from 8.54.0 to 8.55.0 (#8)
- *(deps-dev)* Bump @typescript-eslint/eslint-plugin (#12)
- *(deps-dev)* Bump @typescript-eslint/parser from 6.12.0 to 6.13.2 (#13)
- *(deps-dev)* Bump @typescript-eslint/parser from 6.13.2 to 6.14.0
- *(deps-dev)* Bump @typescript-eslint/eslint-plugin
- *(deps-dev)* Bump eslint from 8.55.0 to 8.56.0
- *(deps-dev)* Bump @typescript-eslint/parser from 6.14.0 to 6.15.0
- *(deps-dev)* Bump @typescript-eslint/eslint-plugin (#24)
- *(deps-dev)* Bump @typescript-eslint/parser from 6.15.0 to 6.17.0 (#27)
- *(deps-dev)* Bump @typescript-eslint/eslint-plugin (#38)
- *(deps-dev)* Bump @typescript-eslint/parser from 6.17.0 to 6.19.1 (#41)
- *(deps-dev)* Bump @typescript-eslint/parser from 6.19.1 to 6.20.0 (#47)
- *(deps-dev)* Bump @typescript-eslint/eslint-plugin (#50)
- *(deps-dev)* Bump @typescript-eslint/parser from 6.20.0 to 6.21.0 (#53)
- *(deps-dev)* Bump @typescript-eslint/eslint-plugin (#56)
- *(deps-dev)* Bump eslint from 8.56.0 to 8.57.0 (#64)


### Refactor

- *(nodejs)* Upgrade to nodejs 20 (#4)
- **BREAKING**: Upgrades to Node.js 20.x


### Security

- *(qodana)* Enable security events writing


### Ci

- *(dependabot)* Add dependabot workflow (#6)
- *(deps)* Bump artifact upload
- *(deps)* Bump typescript-eslint/parser to 7.1.1
- *(qodana)* Add qodana scans (#5)
- *(qodana)* Disable code scan on fork prs
- *(qodana)* Enable code coverage


## [1] - 2020-12-11

### Miscellaneous Tasks

- *(No Category)* Added README.md


<!-- generated by git-cliff -->
82 changes: 82 additions & 0 deletions cliff.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# git-cliff ~ configuration file
# https://git-cliff.org/docs/configuration

[changelog]
# template for the changelog footer
header = """
# Changelog\n
All notable changes to this project will be documented in this file.\n
"""
# template for the changelog body
# https://keats.github.io/tera/docs/#introduction
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
| filter(attribute="scope")
| sort(attribute="scope") %}
- *({{commit.scope}})* {{ commit.message | upper_first }}
{%- if commit.breaking %}
{% raw %} {% endraw %}- **BREAKING**: {{commit.breaking_description}}
{%- endif -%}
{%- endfor -%}
{% raw %}\n{% endraw %}\
{%- for commit in commits %}
{%- if commit.scope -%}
{% else -%}
- *(No Category)* {{ commit.message | upper_first }}
{% if commit.breaking -%}
{% raw %} {% endraw %}- **BREAKING**: {{commit.breaking_description}}
{% endif -%}
{% endif -%}
{% endfor -%}
{% raw %}\n{% endraw %}\
{% endfor %}\n
"""
# template for the changelog footer
footer = """
<!-- generated by git-cliff -->
"""
# remove the leading and trailing whitespace from the templates
trim = true


[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 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
# regex 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"

0 comments on commit 6015f7a

Please sign in to comment.