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

chore: Show new contributors in the changelog #893

Merged
merged 2 commits into from
Mar 26, 2024
Merged

chore: Show new contributors in the changelog #893

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f6826fb
chore: Show new contributors in the changelog
aborgna-q Mar 25, 2024
c75d960
Simpler commit preprocessor regex
aborgna-q Mar 26, 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
37 changes: 30 additions & 7 deletions cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
# Configuration options are organized into tables and keys.
# See documentation for more information on available options.

[remote.github]
owner = "CQCL"
repo = "hugr"
token = ""

[changelog]
# changelog header
header = """
Expand All @@ -18,12 +23,32 @@ body = """
{% else %}\
## Unreleased (XXXX-XX-XX)
{% endif %}\
{% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %}\
{% raw %}\n{% endraw -%}
New Contributors:
{% 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 }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \
{%- endif %}
{%- endfor -%}
{% raw %}\n{% endraw -%}
{%- endif %}\
{% for group, commits in commits | group_by(attribute="group") %}
### {{ group | upper_first }}
{% for commit in commits %}
- {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\
{% endfor %}
{% endfor %}\n
- {% if commit.breaking %}[**breaking**] {% endif %}\
{{ commit.message | split(pat="\n") | first | trim }}\
{% if commit.github.pr_number %} \
([#{{ commit.github.pr_number }}]({{ self::remote_url() }}/pull/{{ commit.github.pr_number }})) \
{%- endif %}
{%- endfor -%}
{% raw %}\n{% endraw -%}
{% endfor %}
{% raw %}\n{% endraw -%}
{%- macro remote_url() -%}
https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
{%- endmacro -%}
"""
# remove the leading and trailing whitespace from the template
trim = true
Expand All @@ -38,9 +63,7 @@ filter_unconventional = true
# process each line of a commit as an individual commit
split_commits = false
# regex for preprocessing the commit messages
commit_preprocessors = [
{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/CQCL/portgraph/issues/${2}))"}, # replace issue numbers
]
commit_preprocessors = [{ pattern = '\(#[0-9]+\)', replace = "" }]
# regex for parsing and grouping commits
commit_parsers = [
{ message = "^feat", group = "Features" },
Expand All @@ -62,7 +85,7 @@ filter_commits = false
# glob pattern for matching git tags
tag_pattern = "v[0-9.]*"
# regex for skipping tags
skip_tags = "v0.1.0-beta.1"
skip_tags = "beta|alpha"
# regex for ignoring tags
ignore_tags = ""
# sort the tags topologically
Expand Down