-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adopt towncrier for changelog management (#15)
- Loading branch information
Showing
5 changed files
with
94 additions
and
1 deletion.
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
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 @@ | ||
Adopt towncrier for changelog management |
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,38 @@ | ||
{%- for section, _ in sections.items() -%} | ||
{%- if section %} | ||
## {{ section }} | ||
{%- endif -%} | ||
{%- if sections[section] -%} | ||
{%- for category, val in definitions.items() if category in sections[section] %} | ||
|
||
|
||
### {{ definitions[category]['name'] }} | ||
|
||
{%- if definitions[category]['showcontent'] %} | ||
{%- for text, values in sections[section][category].items() %} | ||
{%- if values[0].endswith("/0)") %} | ||
|
||
* {{ definitions[category]['name'] }} without explicit PR/issue numbers | ||
{{ text }} | ||
{%- else %} | ||
|
||
* {{ text }} {{ values|join(',\n ') }} | ||
{%- endif %} | ||
|
||
{%- endfor %} | ||
{%- else %} | ||
|
||
* {{ sections[section][category]['']|join(', ') }} | ||
{%- 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
[tool.towncrier] | ||
package = "aiotools" | ||
filename = "CHANGELOG.md" | ||
directory = "changes/" | ||
title_format = "{version} ({project_date})" | ||
template = "changes/template.md" | ||
issue_format = "([#{issue}](https://github.com/achimnol/aiotools/issues/{issue}))" | ||
underlines = ["-", "", ""] | ||
|
||
[[tool.towncrier.type]] | ||
directory = "breaking" | ||
name = "Breaking Changes" | ||
showcontent = true | ||
|
||
[[tool.towncrier.type]] | ||
directory = "feature" | ||
name = "Features" | ||
showcontent = true | ||
|
||
[[tool.towncrier.type]] | ||
directory = "deprecation" | ||
name = "Deprecations" | ||
showcontent = true | ||
|
||
[[tool.towncrier.type]] | ||
directory = "fix" | ||
name = "Fixes" | ||
showcontent = true | ||
|
||
[[tool.towncrier.type]] | ||
directory = "doc" | ||
name = "Documentation Changes" | ||
showcontent = true | ||
|
||
[[tool.towncrier.type]] | ||
directory = "misc" | ||
name = "Miscellaneous" | ||
showcontent = true |
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