📝 Distinguish issues/PRs/commits/refs @ changelog

Author: webknjaz

CHANGES/.TEMPLATE.rst

@@ -14,11 +14,59 @@
 {{ underline * definitions[category]['name']|length }}
 
 {% if definitions[category]['showcontent'] %}
-{% for text, pr_issue_numbers in sections[section][category].items() %}
-- {{ text + '\n' }}
+{% for text, change_note_refs in sections[section][category].items() %}
+- {{ text }}
 
+  {{- '\n' * 2 -}}
+
+  {#-
+      NOTE: Replacing 'e' with 'f' is a hack that prevents Jinja's `int`
+      NOTE: filter internal implementation from treating the input as an
+      NOTE: infinite float when it looks like a scientific notation (with a
+      NOTE: single 'e' char in between digits), raising an `OverflowError`,
+      NOTE: subsequently. 'f' is still a hex letter so it won't affect the
+      NOTE: check for whether it's a (short or long) commit hash or not.
+      Ref: https://github.com/pallets/jinja/issues/1921
+  -#}
+  {%-
+    set pr_issue_numbers = change_note_refs
+    | map('lower')
+    | map('replace', 'e', 'f')
+    | map('int', default=None)
+    | select('integer')
+    | map('string')
+    | list
+  -%}
+  {%- set arbitrary_refs = [] -%}
+  {%- set commit_refs = [] -%}
+  {%- with -%}
+    {%- set commit_ref_candidates = change_note_refs | reject('in', pr_issue_numbers) -%}
+    {%- for cf in commit_ref_candidates -%}
+      {%- if cf | length in (7, 8, 40) and cf | int(default=None, base=16) is not none -%}
+        {%- set _ = commit_refs.append(cf) -%}
+      {%- else -%}
+        {%- set _ = arbitrary_refs.append(cf) -%}
+      {%- endif -%}
+    {%- endfor -%}
+  {%- endwith -%}
+
+  {% if pr_issue_numbers %}
   *Related issues and pull requests on GitHub:*
-  {{ pr_issue_numbers | join(', ') }}.
+  :issue:`{{ pr_issue_numbers | join('`, :issue:`') }}`.
+  {{- '\n' * 2 -}}
+  {%- endif -%}
+
+  {% if commit_refs %}
+  *Related commits on GitHub:*
+  :commit:`{{ commit_refs | join('`, :commit:`') }}`.
+  {{- '\n' * 2 -}}
+  {%- endif -%}
+
+  {% if arbitrary_refs %}
+  *Unlinked references:*
+  {{ arbitrary_refs | join(', ') }}.
+  {{- '\n' * 2 -}}
+  {%- endif -%}
 
 {% endfor %}
 {% else %}

towncrier.toml

@@ -4,7 +4,7 @@
   directory = "CHANGES/"
   title_format = "v{version}"
   template = "CHANGES/.TEMPLATE.rst"
-  issue_format = ":issue:`{issue}`"
+  issue_format = "{issue}"
 
   # NOTE: The types are declared because:
   # NOTE: - there is no mechanism to override just the value of