chore(changelog) : Replace Python script with git-cliff for Changelog generation #115
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -12,6 +12,6 @@ __pycache__/ | |
|
|
||
| .coverage | ||
| bin | ||
| .env | ||
| coverage.xml | ||
| htmlcov/ | ||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -71,7 +71,15 @@ release: install-dev | |
| @V_NO_V=$(VERSION); \ | ||
| sed -i.bak "s/^__version__ = \".*\"/__version__ = \"$$V_NO_V\"/" kubeflow/__init__.py && \ | ||
| rm -f kubeflow/__init__.py.bak | ||
| @PREV_TAG=$$(git tag -l --sort=-creatordate | head -1); \ | ||
| CHANGELOG_FILE=CHANGELOG/CHANGELOG-$$(echo $(VERSION) | cut -d. -f1-2).md; \ | ||
| if [ -z "$$PREV_TAG" ]; then \ | ||
| GITHUB_TOKEN=$${GITHUB_TOKEN} git-cliff --tag $(VERSION) -o $$CHANGELOG_FILE; \ | ||
| elif [ -f "$$CHANGELOG_FILE" ]; then \ | ||
| GITHUB_TOKEN=$${GITHUB_TOKEN} git-cliff $$PREV_TAG..HEAD --tag $(VERSION) --prepend $$CHANGELOG_FILE; \ | ||
| else \ | ||
| GITHUB_TOKEN=$${GITHUB_TOKEN} git-cliff $$PREV_TAG..HEAD --tag $(VERSION) -o $$CHANGELOG_FILE; \ | ||
| fi | ||
|
||
|
|
||
| # make test-python will produce html coverage by default. Run with `make test-python report=xml` to produce xml report. | ||
| .PHONY: test-python | ||
|
|
||
This file contains hidden or 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,56 @@ | ||
| # git-cliff ~ configuration file | ||
| # https://git-cliff.org/docs/configuration | ||
|
|
||
| [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.github.username %} by @{{ commit.github.username }}{% endif %} | ||
| {% endfor -%} | ||
| {% endfor %} | ||
| """ | ||
| trim = true | ||
| render_always = true | ||
|
||
|
|
||
| [git] | ||
rohansaibuddhi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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. Can we also skip commits for Kubeflow SDK releases, like this 46b42d0?
Author
There was a problem hiding this comment. 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 = "^doc", group = "Documentation" }, | ||
| { message = "^perf", group = "Performance" }, | ||
| { message = "^refactor", group = "Refactor" }, | ||
| { message = "^style", group = "Styling" }, | ||
| { message = "^test", group = "Testing" }, | ||
rohansaibuddhi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| { message = "^chore\\(release\\)", skip = true }, | ||
| { message = "^chore\\(deps\\)", skip = true }, | ||
| { message = "^chore", group = "Maintenance" }, | ||
| { message = "^ci", group = "Maintenance" }, | ||
| { body = ".*security", group = "Security" }, | ||
| { message = "^revert", group = "Reverts" }, | ||
| { 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 = "oldest" | ||
|
|
||
| [remote.github] | ||
| owner = "kubeflow" | ||
| repo = "sdk" | ||
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
What if the last tag was 0.2.1rc1, the new release 0.2.1 will only show changes since the RC, not since 0.2.0, right? Could you update it so that for stable releases we compute the previous tag from the last stable tag?
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.
Makes sense. This will lead to duplication of commits between the last stable tag and 0.2.1rc1, considering we do generate changelog for RCs, would that behavior be okay?
In case there is no last stable commit, it would take all commits since the first commit. Is that expected behavior? I know we do not have to deal with this edge case since we already have 0.1.0, but wanted to confirm.