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

ci: changelog formatting and classification improvements #3040

Merged
merged 3 commits into from
Aug 1, 2024
Merged

ci: changelog formatting and classification improvements #3040

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5a72666
only add pr link if pr number is not empty
reubenmiller Aug 1, 2024
7d70cd8
ignore remote-tracking branch commit messages
reubenmiller Aug 1, 2024
d71da04
limit commit group matching to before colon to prevent false positives
reubenmiller Aug 1, 2024
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
30 changes: 16 additions & 14 deletions cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ body = """
{%- endmacro -%}

{%- macro pr_link(num) -%}
[#{{ num }}]({{ self::remote_url() }}/pull/{{ num }})\
{%- if num -%}
{% raw %} {% endraw %}- [#{{ num }}]({{ self::remote_url() }}/pull/{{ num }})\
{% endif -%}
{%- endmacro -%}

{% for group, commits in commits | group_by(attribute="group") %}
Expand Down Expand Up @@ -51,11 +53,11 @@ body = """
{%- endif -%}

{%- if themes -%}
- *{{ themes | join(sep="|") | replace(from="theme:", to="") }}*: {{ commit_message }} - {{ self::pr_link(num=commit.github.pr_number) }}
- *{{ themes | join(sep="|") | replace(from="theme:", to="") }}*: {{ commit_message }}{{ self::pr_link(num=commit.github.pr_number) }}
{% elif commit.scope -%}
- *{{ commit.scope }}*: {{ commit_message }} - {{ self::pr_link(num=commit.github.pr_number) }}
- *{{ commit.scope }}*: {{ commit_message }}{{ self::pr_link(num=commit.github.pr_number) }}
{% else -%}
- *{{ default_scope }}*: {{ commit_message }} - {{ self::pr_link(num=commit.github.pr_number) }}
- *{{ default_scope }}*: {{ commit_message }}{{ self::pr_link(num=commit.github.pr_number) }}
{% endif -%}
{%- endfor -%}
{% endfor %}
Expand Down Expand Up @@ -104,19 +106,19 @@ commit_parsers = [
{ message = "version bump", skip = true },
{ message = "prepare for release", skip = true },
{ message = "Merge branch 'main' into", skip = true },
{ message = "Merge remote-tracking branch 'origin/main' into", skip = true },

# classify commits into sections
{ message = "feat", group = "<!-- 0 -->:rocket: Features" },
{ message = "doc", group = "<!-- 2 -->:notebook: Documentation" },
{ message = "fix", group = "<!-- 1 -->:bug: Bug Fixes" },
{ message = "perf", group = "<!-- 3 -->:runner: Performance" },
{ message = "refactor", group = "<!-- 4 -->:sailboat: Refactor" },
{ message = "style", group = "<!-- 5 -->:nail_care: Styling" },
{ message = "test", group = "<!-- 6 -->:mag_right: Testing" },
{ message = "ci:", group = "<!-- 9 -->:mag_right: CI/CD" },
{ message = "chore", group = "<!-- 7 -->:clipboard: Miscellaneous Tasks" },
{ message = "feat(\\(.+\\))?:", group = "<!-- 0 -->:rocket: Features" },
{ message = "(doc|docs)(\\(.+\\))?:", group = "<!-- 2 -->:notebook: Documentation" },
{ message = "fix(\\(.+\\))?:", group = "<!-- 1 -->:bug: Bug Fixes" },
{ message = "perf(\\(.+\\))?:", group = "<!-- 3 -->:runner: Performance" },
{ message = "(refactor|refactoring)(\\(.+\\))?:", group = "<!-- 4 -->:sailboat: Refactor" },
{ message = "style(\\(.+\\))?:", group = "<!-- 5 -->:nail_care: Styling" },
{ message = "(test|tests|testing)(\\(.+\\))?:", group = "<!-- 6 -->:mag_right: Testing" },
{ message = "ci(\\(.+\\))?:", group = "<!-- 9 -->:mag_right: CI/CD" },
{ message = "chore(\\(.+\\))?:", group = "<!-- 7 -->:clipboard: Miscellaneous Tasks" },
{ body = ".*security", group = "<!-- 8 -->:lock: Security" },
{ message = ".*(deps|Bump).*", group = "Dependencies"},
{ message = ".*", group = "<!-- 7 -->:clipboard: Miscellaneous Tasks"},
]

Expand Down