-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(changelog): add git-cliff for changelog generation
- add CHANGELOG.md
- Loading branch information
Showing
2 changed files
with
254 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,172 @@ | ||
| # Changelog | ||
|
|
||
| All notable changes to this project will be documented in this file. | ||
|
|
||
| ## [2.1.2] - 2024-07-09 | ||
|
|
||
| ### Miscellaneous Tasks | ||
|
|
||
| - *(deps)* Bump @types/node from 20.11.27 to 20.11.28 (#87) | ||
| - *(deps)* Bump @types/node from 20.11.28 to 20.11.30 (#91) | ||
| - *(deps)* Bump typescript from 5.4.2 to 5.4.3 (#89) | ||
| - *(deps)* Bump undici from 5.28.3 to 5.28.4 (#95) | ||
| - *(deps)* Bump @types/node from 20.11.30 to 20.12.2 (#94) | ||
| - *(deps)* Bump eslint-plugin-jest from 27.9.0 to 28.2.0 (#96) | ||
| - *(deps)* Bump @octokit/webhooks from 13.1.1 to 13.2.2 (#99) | ||
| - *(deps)* Bump typescript from 5.4.3 to 5.4.5 (#101) | ||
| - *(deps)* Bump @types/node from 20.12.2 to 20.12.7 (#102) | ||
| - *(deps)* Bump @octokit/webhooks from 13.2.2 to 13.2.7 (#120) | ||
| - *(deps)* Bump eslint-plugin-jest from 28.2.0 to 28.6.0 (#133) | ||
| - *(deps)* Bump braces from 3.0.2 to 3.0.3 (#134) | ||
| - *(deps)* Bump @types/node from 20.12.7 to 20.14.9 (#140) | ||
| - *(deps)* Bump eslint-plugin-github from 4.10.2 to 5.0.1 (#142) | ||
| - *(deps)* Bump prettier from 3.2.5 to 3.3.2 (#143) | ||
| - *(deps)* Bump ts-jest from 29.1.2 to 29.1.5 (#145) | ||
| - *(deps)* Bump @types/node from 20.14.9 to 20.14.10 (#148) | ||
| - *(deps)* Bump typescript from 5.4.5 to 5.5.3 (#147) | ||
| - *(deps-dev)* Bump @typescript-eslint/eslint-plugin (#90) | ||
| - *(deps-dev)* Bump @typescript-eslint/parser from 7.2.0 to 7.4.0 (#92) | ||
| - *(deps-dev)* Bump @typescript-eslint/eslint-plugin (#93) | ||
| - *(deps-dev)* Bump @typescript-eslint/eslint-plugin (#97) | ||
| - *(deps-dev)* Bump @typescript-eslint/parser from 7.4.0 to 7.13.1 (#137) | ||
| - *(deps-dev)* Bump @typescript-eslint/eslint-plugin (#141) | ||
| - *(deps-dev)* Bump @typescript-eslint/parser from 7.13.1 to 7.14.1 (#146) | ||
| - *(deps-dev)* Bump @typescript-eslint/eslint-plugin (#149) | ||
| - *(deps-dev)* Bump @typescript-eslint/parser from 7.14.1 to 7.16.0 (#151) | ||
|
|
||
|
|
||
| ### Security | ||
|
|
||
| - *(No Category)* Release version 2.1.2 | ||
|
|
||
|
|
||
| ## [2.1.1] - 2024-03-13 | ||
|
|
||
| ### Documentation | ||
|
|
||
| - *(No Category)* Version 2.1.1 update | ||
|
|
||
|
|
||
| ### Miscellaneous Tasks | ||
|
|
||
| - *(deps)* Bump @types/node from 20.11.17 to 20.11.25 (#81) | ||
| - *(deps)* Bump typescript from 5.3.3 to 5.4.2 (#82) | ||
| - *(deps)* Bump eslint-plugin-github from 4.10.1 to 4.10.2 (#84) | ||
|
|
||
|
|
||
| ### Build | ||
|
|
||
| - *(No Category)* Update tsconfig for newer options | ||
|
|
||
|
|
||
| ## [2.1] - 2024-03-10 | ||
|
|
||
| ### Bug Fixes | ||
|
|
||
| - *(No Category)* Remove ' from multiple project key inputs | ||
| - *(No Category)* Remove set failed calls | ||
|
|
||
|
|
||
| ### Documentation | ||
|
|
||
| - *(No Category)* Bump version in README.md to 2.1 | ||
| - *(No Category)* Set icon and color in action.yml | ||
| - *(No Category)* Update rest of docs with 2.1 version | ||
|
|
||
|
|
||
| ### Miscellaneous Tasks | ||
|
|
||
| - *(deps)* Bump typescript from 5.2.2 to 5.3.2 (#24) | ||
| - *(deps)* Bump @octokit/webhooks from 12.0.7 to 12.0.8 (#23) | ||
| - *(deps)* Bump @types/node from 20.9.1 to 20.10.0 (#21) | ||
| - *(deps)* Bump @types/jest from 29.5.8 to 29.5.10 (#22) | ||
| - *(deps)* Bump @octokit/webhooks from 12.0.8 to 12.0.10 (#27) | ||
| - *(deps)* Bump @types/node from 20.10.0 to 20.10.3 (#26) | ||
| - *(deps)* Bump @types/node from 20.10.3 to 20.10.4 (#32) | ||
| - *(deps)* Bump prettier from 3.1.0 to 3.1.1 (#36) | ||
| - *(deps)* Bump typescript from 5.3.2 to 5.3.3 (#35) | ||
| - *(deps)* Bump @types/jest from 29.5.10 to 29.5.11 (#34) | ||
| - *(deps)* Bump @types/node from 20.10.4 to 20.10.5 | ||
| - *(deps)* Bump @types/node from 20.10.5 to 20.10.6 (#43) | ||
| - *(deps)* Bump @octokit/webhooks from 12.0.10 to 12.0.11 (#51) | ||
| - *(deps)* Bump eslint-plugin-jest from 27.6.0 to 27.6.3 (#53) | ||
| - *(deps)* Bump @types/node from 20.10.6 to 20.11.6 (#60) | ||
| - *(deps)* Bump ts-jest from 29.1.1 to 29.1.2 (#63) | ||
| - *(deps)* Bump @types/jest from 29.5.11 to 29.5.12 (#65) | ||
| - *(deps)* Bump @types/node from 20.11.6 to 20.11.17 (#70) | ||
| - *(deps)* Bump prettier from 3.1.1 to 3.2.5 (#68) | ||
| - *(deps)* Bump @octokit/webhooks from 12.0.11 to 13.0.1 (#76) | ||
| - *(deps)* Bump undici from 5.27.2 to 5.28.3 (#74) | ||
| - *(deps)* Bump @octokit/webhooks from 13.0.1 to 13.1.0 (#80) | ||
| - *(deps)* Bump eslint-plugin-jest from 27.6.3 to 27.9.0 (#79) | ||
| - *(deps-dev)* Bump @typescript-eslint/eslint-plugin (#29) | ||
| - *(deps-dev)* Bump @typescript-eslint/parser from 6.12.0 to 6.13.2 (#30) | ||
| - *(deps-dev)* Bump eslint from 8.54.0 to 8.55.0 (#25) | ||
| - *(deps-dev)* Bump @typescript-eslint/eslint-plugin (#33) | ||
| - *(deps-dev)* Bump eslint from 8.55.0 to 8.56.0 | ||
| - *(deps-dev)* Bump @typescript-eslint/eslint-plugin | ||
| - *(deps-dev)* Bump @typescript-eslint/parser from 6.13.2 to 6.15.0 | ||
| - *(deps-dev)* Bump @typescript-eslint/eslint-plugin | ||
| - *(deps-dev)* Bump @typescript-eslint/eslint-plugin (#44) | ||
| - *(deps-dev)* Bump @typescript-eslint/parser from 6.15.0 to 6.17.0 (#46) | ||
| - *(deps-dev)* Bump @typescript-eslint/eslint-plugin (#58) | ||
| - *(deps-dev)* Bump @typescript-eslint/parser from 6.17.0 to 6.19.1 (#59) | ||
| - *(deps-dev)* Bump @typescript-eslint/eslint-plugin (#66) | ||
| - *(deps-dev)* Bump @typescript-eslint/parser from 6.19.1 to 6.21.0 (#71) | ||
| - *(deps-dev)* Bump eslint from 8.56.0 to 8.57.0 (#78) | ||
| - *(deps-dev)* Bump @typescript-eslint/eslint-plugin (#75) | ||
| - *(No Category)* Add projectKeys to action.yml | ||
|
|
||
|
|
||
| ### Refactor | ||
|
|
||
| - *(No Category)* Use getMultilineInput from core | ||
|
|
||
|
|
||
| ### Security | ||
|
|
||
| - *(qodana)* Enable code coverage in qodana | ||
|
|
||
|
|
||
| ### Build | ||
|
|
||
| - *(No Category)* Generate action bundle for 2.1 | ||
|
|
||
|
|
||
| ### Ci | ||
|
|
||
| - *(deps)* Update action versions | ||
| - *(qodana)* Disable qodana code scan on fork prs | ||
|
|
||
|
|
||
| ## [2] - 2023-11-24 | ||
|
|
||
| ### Miscellaneous Tasks | ||
|
|
||
| - *(deps)* Bump node-notifier from 8.0.0 to 8.0.2 (#3) | ||
| - *(deps)* Bump lodash from 4.17.20 to 4.17.21 (#4) | ||
| - *(deps)* Bump hosted-git-info from 2.8.8 to 2.8.9 | ||
| - *(deps)* Bump ws from 7.4.1 to 7.5.1 | ||
| - *(deps)* Bump glob-parent from 5.1.1 to 5.1.2 | ||
| - *(deps)* Bump node-fetch from 2.6.1 to 2.6.7 | ||
| - *(deps)* Bump path-parse from 1.0.6 to 1.0.7 | ||
| - *(deps)* Bump tmpl from 1.0.4 to 1.0.5 | ||
| - *(No Category)* Update package.json with package name | ||
| - *(No Category)* Bump dependency versions | ||
|
|
||
|
|
||
| ## [1] - 2020-12-11 | ||
|
|
||
| ### Miscellaneous Tasks | ||
|
|
||
| - *(No Category)* Update dist build | ||
| - *(No Category)* Setup tests | ||
| - *(No Category)* Added hello world test workflow | ||
|
|
||
|
|
||
| ### Bug | ||
|
|
||
| - *(No Category)* Fix how pull request title is retrieved | ||
|
|
||
|
|
||
| <!-- generated by git-cliff --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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" |