diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index bedc75f1f52..6892d116b0a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -12,17 +12,10 @@ are the most critical to review. closes: #XXXX + - -# Changelog -All notable changes to this project will be documented in this file. -""" -# template for the changelog body -# https://tera.netlify.app/docs/#introduction -body = """ -{% if version %}\ - ## [{{ 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 | upper_first }}\ - {% endfor %} -{% endfor %}\n -""" -# remove the leading and trailing whitespace from the template -trim = true -# changelog footer -footer = """ - -""" - -[git] -# parse the commits based on https://www.conventionalcommits.org -conventional_commits = true -# filter out the commits that are not conventional -filter_unconventional = true -# process each line of a commit as an individual commit -split_commits = true -# regex for preprocessing the commit messages -commit_preprocessors = [ - # A reference to an issue is appended to commits that looks like "(#1234)", this will be replaced - # with a link to that issue, e.g. "[#$1234](https://github.com/cosmos/ibc-go/issues/1234)". - { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/cosmos/ibc-go/issues/${2}))" }, - # any reference to a pr like "pr-1234" will be replaced with a link to the PR. - { pattern = '\(pr-([0-9]+)\)', replace = "([#${1}](https://github.com/cosmos/ibc-go/pulls/${1}))" }, - - # the following patterns only exist because "split_commits" is set to true, and we are processesing - # each line of the commit as a separate message. - # these exist to filter out common messages that appear in commit messages that are technically - # conventional, but we do not way to include in the changelog. - { pattern = '^Signed-off-by:.*', replace='' }, - { pattern = '^Co-authored-by:.*', replace='' }, - # don't include references to issues as changelog entries. - { pattern = '^ref:.*', replace='' }, - # exclude CVSS format, CVE can still be included in regular conventinal commits. - { pattern = 'CVSS:.*', replace='' }, - # don't include dependabot auto merge entries. - { pattern = '.*dependabot-automerge-.*', replace='' }, - # don't include statements saying which issue is closed. - { pattern = '^closes:.*', replace='' }, - # remove standalone links in the commit messages. - { pattern = '^https://.*', replace='' }, - # remove lines with html. - { pattern = '^<.*', replace='' }, -] - -# regex for parsing and grouping commits -commit_parsers = [ - # specifying the number in a comment is a workaround to enable ordering of groups. - # these comments are stripped out of the markdown with the filter "{{ group | striptags | trim | upper_first }}" - # above in the body template. - { message = "^((?i)deps|(?i)dep|(?i)build)", group = "Dependencies" }, - { message = '^.*\(api\)!', group = "API Breaking" }, - { message = '^.*\(statemachine\)!', group = "State Machine Breaking" }, - { message = "^((?i)improvements|(?i)imp)", group = "Improvements" }, - { message = "^((?i)feature|(?i)feat)", group = "Features" }, - { message = "^((?i)fix|(?i)bug)", group = "Bug Fixes" }, - { message = "^((?i)doc|(?i)docs|(?i)documentation)", group = "Documentation" }, - { message = "^((?i)test|(?i)e2e)", group = "Testing" }, - { message = "^((?i)deprecated)", group = "Deprecated" }, - { message = "^((?i)chore|(?i)misc|(?i)nit)", group = "Miscellaneous Tasks" }, -] -# filter out the commits that are not matched by commit parsers -filter_commits = false -# glob pattern for matching git tags -tag_pattern = "v[0-9]*" -# regex for skipping tags -skip_tags = "" -# regex for ignoring tags -ignore_tags = "" -# sort the tags chronologically -date_order = false -# sort the commits inside sections by oldest/newest order -sort_commits = "oldest"