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.

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

chore(changelog): add git-cliff configuration #1200

Merged
merged 2 commits into from
Sep 7, 2023

Conversation

orhun
Copy link
Contributor

@orhun orhun commented Sep 5, 2023

Description of change

Add git-cliff configuration.

Changelog preview:

preview

How has this been tested? (if applicable)

N/a

Copy link
Contributor

@oddgrd oddgrd left a comment

Choose a reason for hiding this comment

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

Thanks @orhun, this looks great! 🤩

I have two (non-blocking) questions since I'm not familiar with git-cliff yet:

  • How will commits that don't match any of the regexes in commit_parsers be grouped?
  • How is it determined which part of the codebase the commit belongs too (e.g. (gateway) <commit message>?

@orhun
Copy link
Contributor Author

orhun commented Sep 6, 2023

How will commits that don't match any of the regexes in commit_parsers be grouped?

If they are conventional, they will appear in their own section. For example, foo(bar): xyz will be:

### Foo
- (bar): xyz

If they are not conventional, they will be skipped. We can potentially set up git-cliff to utilize unconventional commits as well but the most of the codebase seems to be using conventional commits so I'd say there is no need for that. Conventional commits gud.

How is it determined which part of the codebase the commit belongs too (e.g. (gateway) <commit message>?

From the scope of the commit message, e.g. feat(gateway): <commit message>

@jonaro00
Copy link
Member

jonaro00 commented Sep 6, 2023

Alright, so we'll have to make sure we modify names of commits when we squash them (if needed). Would be good to have non-matching ones get thrown into Misc. just in case.

@orhun
Copy link
Contributor Author

orhun commented Sep 6, 2023

Done in b3bd557

@oddgrd
Copy link
Contributor

oddgrd commented Sep 7, 2023

Perfect, thanks!

@oddgrd oddgrd merged commit b3de162 into shuttle-hq:main Sep 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants