-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update towncrier changelog template (#1070)
- Loading branch information
Showing
6 changed files
with
19 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
Added the `sphinx-changelog <https://github.com/OpenAstronomy/sphinx-changelog>`__ | ||
package dependency for rendering a ``changelog`` from news fragments using | ||
`towncrier <https://github.com/twisted/towncrier>`__ and generating a release | ||
``changelong``. (:user:`bjlittle`) | ||
``changelog``. (:user:`bjlittle`) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,3 @@ | ||
Introduced temporary maximum pin ``towncrier <24.7.0`` due to breaking change | ||
for ``sphinx-changelog``. (:user:`bjlittle`) | ||
for `sphinx-changelog <https://github.com/OpenAstronomy/sphinx-changelog>`__. | ||
(:user:`bjlittle`) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
Unpinned ``towncrier`` and introduced minimum pin ``sphinx-changelog>=1.6.0``. | ||
(:user:`bjlittle`) | ||
Unpinned `towncrier <https://github.com/twisted/towncrier>`__ and introduced | ||
minimum pin ``sphinx-changelog >=1.6.0``. (:user:`bjlittle`) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
Updated the `towncrier <https://github.com/twisted/towncrier>`__ ``changelog`` | ||
template. (:user:`bjlittle`) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,40 +1,33 @@ | ||
{% for section in sections %} | ||
{% set underline = underlines[0] %} | ||
{% if section %} | ||
{{ section }} | ||
{{ underline * section|length }}{% set underline = underlines[1] %} | ||
.. _gv-changelog-{{ versiondata.date }}: | ||
|
||
{% if render_title %} | ||
v{{ versiondata.version }} ({{ versiondata.date }}) | ||
{{ top_underline * ((versiondata.version + versiondata.date)|length + 4)}} | ||
{% endif %} | ||
{% if sections[section] %} | ||
{% for category in definitions if category in sections[section] %} | ||
{% for section, _ in sections.items() %} | ||
{% set underline = underlines[0] %} | ||
|
||
{% if sections[section] %} | ||
{% for category, val in definitions.items() if category in sections[section]%} | ||
{{ definitions[category]['name'] }} | ||
{{ underline * (definitions[category]['name']|length + 1) }} | ||
|
||
{% if definitions[category]['showcontent'] %} | ||
{% for text, values in sections[section][category]|dictsort(by='value') %} | ||
{% if not values or values[0][0] == '+' %} | ||
- {{ text }} | ||
{% else %} | ||
{% set comma = joiner(', ') %} | ||
- {% for value in values|sort %}{{ comma() }}:fa:`code-pull-request` :pull:`{{ value[1:] }}`{% endfor %}: {{ text|replace(":issue:", ":far:`circle-dot` :issue:") }} | ||
{% endif %} | ||
{% endfor %} | ||
|
||
{% else %} | ||
- {{ sections[section][category]['']|join(', ') }} | ||
{% endfor %} | ||
|
||
{% endif %} | ||
{% if sections[section][category]|length == 0 %} | ||
|
||
No significant changes. | ||
|
||
{% else %} | ||
{% endif %} | ||
|
||
{% endfor %} | ||
{% else %} | ||
|
||
No significant changes. | ||
|
||
|
||
{% endif %} | ||
{% endfor %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters