diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d2499346b4..3bb734a054 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -89,6 +89,7 @@ it is not encouraged, you can use: - `pr-[PRNumber].type` for a PR with no related issue - `sdk-[iOSSDKIssueNumber].type` for a PR related a matrix-ios-sdk issue - `kit-[iOSKitIssueNumber].type` for a PR related a matrix-ios-kit issue +- `x-nolink-[AnyNumber].type` for a PR with a change entry that will not have a link automatically appended. It must be used for internal project update only. `AnyNumber` should be a value that does not clash with existing files. To preview the changelog for pending changelog entries, use: diff --git a/changelog.d/_template.md.jinja b/changelog.d/_template.md.jinja index 2a7b9d6fed..a90e258294 100644 --- a/changelog.d/_template.md.jinja +++ b/changelog.d/_template.md.jinja @@ -25,13 +25,19 @@ {%- set gh_issue = value.replace("#", "") -%} {{- links.append( "[#%s](%s/issues/%s)" | format(gh_issue, gh_element, gh_issue) ) | default("", True) -}} {%- elif value.startswith("pr-") %} - {%- set pr = value.replace("pr-", "#") -%} - {{- links.append(pr) | default("", True) -}} + {%- set pr = value.replace("pr-", "") -%} + {{- links.append( "[#%s](%s/pull/%s)" | format(pr, gh_sdk, pr) ) | default("", True) -}} + {%- elif value.startswith("x-nolink-") %} + {{- nil | default("", True) -}} {% else %} {{- links.append(value) | default("", True) -}} {% endif -%} {% endfor -%} +{% if links|length == 0 %} +- {{ text }} +{% else %} - {{ text }} ({{ links | join(', ') }}) +{% endif %} {% endfor %} {% else %} - {{ sections[section][category]['']|join(', ') }} diff --git a/changelog.d/pr-1196.build b/changelog.d/pr-1196.build new file mode 100644 index 0000000000..d24a7e1910 --- /dev/null +++ b/changelog.d/pr-1196.build @@ -0,0 +1 @@ +CHANGES.md: Use towncrier to manage the change log. More info in [CONTRIBUTING](CONTRIBUTING.md#changelog). \ No newline at end of file