Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add git cliff toml to support generation of changelog #2697

Merged
merged 19 commits into from
Nov 15, 2022
Merged

Add git cliff toml to support generation of changelog #2697

Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
670d534
feat: adding git cliff toml
chatton Sep 8, 2022
d8cafd4
chore: using docker image to generate changelog
chatton Nov 7, 2022
4b53323
Merge branch 'main' into git-cliff-2106
chatton Nov 7, 2022
16ee689
chore: adding usage information in cliff.toml
chatton Nov 7, 2022
6706aed
Merge branch 'main' into git-cliff-2106
chatton Nov 8, 2022
3b6c79d
Merge branch 'main' into git-cliff-2106
chatton Nov 8, 2022
87c12dd
Merge branch 'main' into git-cliff-2106
chatton Nov 8, 2022
a875571
Merge branch 'main' into git-cliff-2106
chatton Nov 9, 2022
1813f59
Merge branch 'main' into git-cliff-2106
chatton Nov 11, 2022
4569ff0
chore: implemnted regex change suggestions
chatton Nov 11, 2022
aabaed7
chore: updating CONTRIBUTING.md with details about commit messages
chatton Nov 11, 2022
8490b30
Merge branch 'main' into git-cliff-2106
chatton Nov 14, 2022
2353229
Update CONTRIBUTING.md
chatton Nov 14, 2022
140d251
Merge branch 'main' into git-cliff-2106
chatton Nov 14, 2022
d90488e
chore: addressing PR feedback and updating pull request template
chatton Nov 14, 2022
13403c9
Merge branch 'main' into git-cliff-2106
chatton Nov 14, 2022
0c028ac
Merge branch 'main' into git-cliff-2106
chatton Nov 15, 2022
3ba101c
chore: adding support for processing each individual line of the comm…
chatton Nov 15, 2022
0a30c21
Merge branch 'main' into git-cliff-2106
chatton Nov 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
chore: adding usage information in cliff.toml
  • Loading branch information
@chatton
chatton committed Nov 7, 2022
commit 16ee6890bd14372f02f719549bddcd72dba64635
33 changes: 30 additions & 3 deletions cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,34 @@
[changelog]
# changelog header
header = """
# Changelog\n
All notable changes to this project will be documented in this file.\n
<!--
Usage:

Change log entries are generated by git cliff ref: https://github.com/orhun/git-cliff
This can be run using "make changelog tag=vx.y.z"

Each commit should be conventional, the following message groups are supported.

* feat, feature
* imp
* bug, fix
* deprecated
* api-breaking
* state-machine-breaking, smb
Copy link
Contributor Author

@chatton chatton Nov 7, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these are arbitrary and can be decided by us. Note: these strings will not appear in the changelog entry, they are used to group the commits in the changelog.

Copy link
Member

@damiannolan damiannolan Nov 11, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recall some usage of a ! prefix which would indicate an API breaking change.
I'd like to suggest maybe adopting a ! prefix for api breaking changes and !! or something else for state machine breaking.

I feel like its common for us to use squash commits / PR titles similar to:

refactor: some refactor of a module or chore: cleaning up unused to code

But it might be nice to be able to prefix these like:

!refactor: some refactor that breaks an api or !!feat: this feat introduces a state machine breaking change.

Any thoughts on this?


Types of changes (Stanzas):

"Features" for new features. (feat, feature)
"Improvements" for changes in existing functionality. (imp)
"Deprecated" for soon-to-be removed features.
"Bug Fixes" for any bug fixes. (bug, fix)
"API Breaking" for breaking exported APIs used by developers building on SDK. (api-breaking)
"State Machine Breaking" for any changes that result in a different AppState given same genesisState and txList. (state-machine-breaking, smb)
Ref: https://keepachangelog.com/en/1.0.0/
-->

# Changelog
All notable changes to this project will be documented in this file.
"""
# template for the changelog body
# https://tera.netlify.app/docs/#introduction
Expand Down Expand Up @@ -56,7 +82,8 @@ commit_parsers = [
{ message = "^((?i)fix|(?i)bug)", group = "<!-- 5 -->Bug Fixes" },
{ message = "^((?i)doc|(?i)docs|(?i)documentation)", group = "<!-- 6 -->Documentation" },
{ message = "^((?i)test|(?i)e2e)", group = "<!-- 7 -->Testing" },
{ message = "^((?i)chore|(?i)misc|(?i)nit)", group = "<!-- 8 -->Miscellaneous Tasks" },
{ message = "^((?i)deprecated)", group = "<!-- 8 -->Deprecated" },
{ message = "^((?i)chore|(?i)misc|(?i)nit)", group = "<!-- 9 -->Miscellaneous Tasks" },
]
# filter out the commits that are not matched by commit parsers
filter_commits = false
Expand Down