|
| 1 | +[remote] |
| 2 | +# Strictly don't connect to the internet to generate the changelog. |
| 3 | +offline = false |
| 4 | + |
| 5 | +[remote.github] |
| 6 | +# TODO: Fill in the owner and repo so that the links in the changelog work correctly. |
| 7 | +owner = "" |
| 8 | +repo = "" |
| 9 | + |
| 10 | +[changelog] |
| 11 | +# A Tera template to be rendered for each release in the changelog. |
| 12 | +header = """ |
| 13 | +# Changelog |
| 14 | +
|
| 15 | +Since we follow |
| 16 | +[Conventional Commits](https://decisions.seedcase-project.org/why-conventional-commits/) |
| 17 | +for commit messages, we can automatically create |
| 18 | +releases of the Python package based on those messages. The |
| 19 | +releases are also published to Zenodo for easier discovery, archiving, |
| 20 | +and citation. |
| 21 | +
|
| 22 | +We use |
| 23 | +[Cocogitto](https://decisions.seedcase-project.org/why-semantic-release-with-cocogitto/) |
| 24 | +to automate releases, which uses |
| 25 | +[SemVar](https://semverdoc.org) as the version numbering scheme, |
| 26 | +and [Git Cliff](https://decisions.seedcase-project.org/why-changelog-with-git-cliff/) |
| 27 | +to generate the changelog from commit messages. |
| 28 | +
|
| 29 | +Because releases are generated automatically, new versions are released |
| 30 | +often---sometimes several times in a day--- |
| 31 | +and each release usually contains only a small number of changes. Below |
| 32 | +is a list of the releases and the changes |
| 33 | +within each one. |
| 34 | +
|
| 35 | +Commits from bots, like `dependabot` or `pre-commit-ci`, are not included in |
| 36 | +the changelog. |
| 37 | +""" |
| 38 | + |
| 39 | +body = """ |
| 40 | +{%- macro remote_url() -%} |
| 41 | + https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }} |
| 42 | +{%- endmacro -%} |
| 43 | +
|
| 44 | +{% macro print_commit(commit) -%} |
| 45 | + - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\ |
| 46 | + {% if commit.breaking %}**breaking** {% endif %}\ |
| 47 | + {{ commit.message | upper_first }} \ |
| 48 | + {% if commit.remote.username %} by \ |
| 49 | + {% if commit.remote.username is containing("[bot]") %} |
| 50 | + `@{{ commit.remote.username }}`\ |
| 51 | + {% else %}\ |
| 52 | + [`@{{ commit.remote.username }}`](https://github.com/{{ commit.remote.username }})\ |
| 53 | + {% endif %}\ |
| 54 | + {% endif %} \ |
| 55 | + ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\ |
| 56 | +{% endmacro -%} |
| 57 | +
|
| 58 | +{% if version %}\ |
| 59 | + {% if previous.version %}\ |
| 60 | + ## [{{ version | trim_start_matches(pat="v") }}]\ |
| 61 | + ({{ self::remote_url() }}/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }} |
| 62 | + {% else %}\ |
| 63 | + ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} |
| 64 | + {% endif %}\ |
| 65 | +{% else %}\ |
| 66 | + ## [unreleased] |
| 67 | +{% endif %}\ |
| 68 | +
|
| 69 | +{% for group, commits in commits | group_by(attribute="group") %} |
| 70 | + ### {{ group | striptags | trim | upper_first }} |
| 71 | + {% for commit in commits |
| 72 | + | filter(attribute="scope") |
| 73 | + | sort(attribute="scope") %} |
| 74 | + {{ self::print_commit(commit=commit) }} |
| 75 | + {%- endfor %} |
| 76 | + {% for commit in commits %} |
| 77 | + {%- if not commit.scope -%} |
| 78 | + {{ self::print_commit(commit=commit) }} |
| 79 | + {% endif -%} |
| 80 | + {% endfor -%} |
| 81 | +{% endfor -%} |
| 82 | +
|
| 83 | +{%- if github -%} |
| 84 | +{% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %} |
| 85 | + ### ❤️ New contributors |
| 86 | +{% endif %}\ |
| 87 | +{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %} |
| 88 | + {% if contributor.username is containing("[bot]") %} |
| 89 | + - `@{{ contributor.username }}` started making automated contributions\ |
| 90 | + {% else %}\ |
| 91 | + - [`@{{ contributor.username }}`](https://github.com/{{ contributor.username }}) made their first contribution |
| 92 | + {%- if contributor.pr_number %} in \ |
| 93 | + [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }})\ |
| 94 | + {%- endif %} |
| 95 | + {%- endif %}\ |
| 96 | +{%- endfor -%} |
| 97 | +{%- endif %} |
| 98 | +
|
| 99 | +""" |
| 100 | + |
| 101 | +# Remove leading and trailing whitespaces from the changelog's body. |
| 102 | +trim = true |
| 103 | +output = "CHANGELOG.md" |
| 104 | + |
| 105 | +[git] |
| 106 | +commit_preprocessors = [ |
| 107 | + # TODO: Replace OWNER and REPO with actual owner and repo |
| 108 | + # Replace pull request numbers with links to GitHub. |
| 109 | + { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "[#${2}](https://github.com/OWNER/REPO/pull/${2})" }, |
| 110 | + # Check spelling of the commit message using https://github.com/crate-ci/typos. |
| 111 | + # If the spelling is incorrect, it will be fixed automatically. |
| 112 | + { pattern = '.*', replace_command = 'uvx typos --write-changes -' }, |
| 113 | + # Remove gitmoji, both actual UTF emoji and :emoji: |
| 114 | + { pattern = ' *(:\w+:|[\p{Emoji_Presentation}\p{Extended_Pictographic}](?:\u{FE0F})?\u{200D}?) *', replace = "" }, |
| 115 | +] |
| 116 | + |
| 117 | +commit_parsers = [ |
| 118 | + # Don't include commits from bots. |
| 119 | + { field = "author.name", pattern = ".*(dependabot|github-actions|pre-commit-ci).*", skip = true }, |
| 120 | + # Don't include the version update commits. |
| 121 | + { message = ".*update version", skip = true }, |
| 122 | + { message = "^feat", group = "<!-- 0 -->✨ Features" }, |
| 123 | + { message = "^fix", group = "<!-- 1 -->🐛 Fixes" }, |
| 124 | + { message = "^refactor", group = "<!-- 2 -->♻️ Refactor" }, |
| 125 | + { message = "^docs", group = "<!-- 3 -->📝 Documentation" }, |
| 126 | + { message = "^perf", group = "<!-- 4 -->⚡ Performance" }, |
| 127 | + { message = "^style", group = "<!-- 5 -->💄 Style" }, |
| 128 | + { message = "^test", group = "<!-- 6 -->🧪 Tests" }, |
| 129 | + { message = "^ci", group = "<!-- 7 -->👷 CI/CD" }, |
| 130 | + { message = "^build", group = "<!-- 8 -->🧱 Build system" }, |
| 131 | + { message = "^chore", group = "<!-- 9 -->🧹 Chores" }, |
| 132 | + { message = "^revert", group = "<!-- 10 -->⏪ Revert" }, |
| 133 | + { message = ".*", skip = true }, |
| 134 | +] |
0 commit comments