-
Notifications
You must be signed in to change notification settings - Fork 47
chore(changelog) : Replace Python script with git-cliff for Changelog generation #115
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,6 +12,6 @@ __pycache__/ | |
|
|
||
| .coverage | ||
| bin | ||
|
|
||
| .env | ||
| coverage.xml | ||
| htmlcov/ | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| # git-cliff ~ configuration file | ||
| # https://git-cliff.org/docs/configuration | ||
|
|
||
| [remote.github] | ||
| owner = "kubeflow" | ||
| repo = "sdk" | ||
|
|
||
| [changelog] | ||
| # Template for the changelog body | ||
| body = """ | ||
| {% if version %}\ | ||
| # [{{ version | trim_start_matches(pat="v") }}](https://github.com/kubeflow/sdk/releases/tag/{{ 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 | striptags | trim | upper_first }} | ||
|
|
||
| {% for commit in commits -%} | ||
| - {{ commit.message | split(pat="(#") | first | trim }}{% if commit.breaking %} [**breaking**]{% endif %}{% for link in commit.links %} ([{{ link.text }}]({{ link.href }})){% endfor %}{% if commit.remote.username %} by @{{ commit.remote.username }}{% endif %} | ||
| {% endfor -%} | ||
| {% endfor %} | ||
|
|
||
| {%- if github -%} | ||
| {% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %} | ||
| ## New Contributors ❤️ | ||
| {% endif -%} | ||
| {% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %} | ||
| * @{{ contributor.username }} made their first contribution | ||
| {%- if contributor.pr_number %} in \ | ||
| [#{{ contributor.pr_number }}](https://github.com/kubeflow/sdk/pull/{{ contributor.pr_number }}) \ | ||
| {%- endif %} | ||
| {%- endfor -%} | ||
| {%- endif %} | ||
| """ | ||
| trim = true | ||
|
|
||
| [git] | ||
| conventional_commits = false | ||
| filter_unconventional = false | ||
| require_conventional = false | ||
| split_commits = false | ||
| commit_preprocessors = [] | ||
| protect_breaking_commits = false | ||
| commit_parsers = [ | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we also skip commits for Kubeflow SDK releases, like this 46b42d0?
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. would we want this to be an exact match like '^Kubeflow SDK Official Release' or something more flexible like ".*Release [0-9]". If it is the former, we should probably add the convention to RELEASE.md as well, let me know what you think. |
||
| { message = "^feat", group = "New Features" }, | ||
| { message = "^fix", group = "Bug Fixes" }, | ||
| { message = "^chore", group = "Maintenance" }, | ||
| { message = "^revert", group = "Reverts" }, | ||
| { message = "^Kubeflow SDK Official Release", skip = true }, | ||
| { message = ".*", group = "Other Changes" }, | ||
| ] | ||
| filter_commits = false | ||
| link_parsers = [ | ||
| { pattern = '\(#(\d+)\)', href = "https://github.com/kubeflow/sdk/pull/$1", text = "#$1" }, | ||
| ] | ||
| use_branch_tags = false | ||
| topo_order = false | ||
| sort_commits = "newest" | ||
Uh oh!
There was an error while loading. Please reload this page.