-
Notifications
You must be signed in to change notification settings - Fork 109
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
Add Git-Cliff Changelog #515
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewed 2 of 2 files at r1, all commit messages.
Reviewable status: all files reviewed, 3 unresolved discussions (waiting on @blakehatch and @MarcusSorealheis)
CHANGELOG.md
line 5 at r1 (raw file):
All notable changes to this project will be documented in this file. ## [0.1.0-alpha] - 2023-12-19
Super nice. Let's stick to 0.1.0
without the alpha though.
CHANGELOG.md
line 437 at r1 (raw file):
- [BreakingChange] Scheduler config now supports multiple impls - ([384f14e](https://github.com/TraceMachina/nativelink/commit/384f14e593e88294ffbe01471416b8d1424442ac)) <!-- generated by git-cliff -->
Even this generated file should go through the pre-commit hooks.
cliff.toml
line 89 at r1 (raw file):
{ message = "Remove", group = "<!-- 7 -->⚙️ Miscellaneous" }, { message = "Separate", group = "<!-- 2 -->🛠️ Refactor" }, { message = ".*", group = "<!-- 7 -->⚙️ Miscellaneous" },
We should have one category for version updates and bumps.
2d47507
to
1e57643
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewable status: 0 of 2 files reviewed, 3 unresolved discussions (waiting on @aaronmondal and @MarcusSorealheis)
CHANGELOG.md
line 5 at r1 (raw file):
Previously, aaronmondal (Aaron Siddhartha Mondal) wrote…
Super nice. Let's stick to
0.1.0
without the alpha though.
Done.
CHANGELOG.md
line 437 at r1 (raw file):
Previously, aaronmondal (Aaron Siddhartha Mondal) wrote…
Even this generated file should go through the pre-commit hooks.
Oops these should not be getting through on two file commits mb 😅
cliff.toml
line 89 at r1 (raw file):
Previously, aaronmondal (Aaron Siddhartha Mondal) wrote…
We should have one category for version updates and bumps.
Done.
Please mention any issues this may be related to. |
@aaronmondal Why? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems good to go for me. I'm curious why no Alpha but I will follow up.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewed 2 of 2 files at r2, all commit messages.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @blakehatch)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
As a follow-up we should add a ~weekly running cronjob to auto-update this log. We can do something similar to the cronjobs we already have here: https://github.com/TraceMachina/nativelink/blob/main/.github/workflows/codeql.yaml or here: https://github.com/TraceMachina/nativelink/blob/main/.github/workflows/scorecard.yaml but without the on push
invocations. That way it'll only run once a week and won't clutter our history.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @blakehatch)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed however if we do this we should adopt stricter commit message standards (probably https://www.conventionalcommits.org/en/v1.0.0/) and then clean up the regex parser and filter out non standard commit messages. With filtering in place we could actually filter out more superfluous commits as well by default if they're intentionally not written in conventional commit structure and avoid cluttering up the history by default.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @blakehatch)
1e57643
to
775fb1f
Compare
Description
#518
Add Changelog for 0.1.0-alpha that is automatically generated by git-cliff. Should be reusable for future releases might require minor regex changes.
This change is