forked from pybamm-team/PyBaMM
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
pybamm-team#2885 Add
towncrier
configuration file
- Loading branch information
1 parent
1632dc8
commit 9f3331b
Showing
1 changed file
with
35 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# towncrier.toml | ||
# A configuration file for towncrier. To customise, browse the configuration reference at | ||
# https://towncrier.readthedocs.io/en/stable/configuration.html | ||
|
||
# The following tables for entry types are ordered in the CHANGELOG as they appear below. | ||
|
||
[tool.towncrier] | ||
package = "pybamm" | ||
directory = "newsfragments" | ||
filename = "CHANGELOG.md" | ||
underlines = ["", "", ""] | ||
all_bullets = true | ||
title_format = "## [{version}](https://github.com/pybamm-team/PyBaMM/tree/v{version}) - {project_date}" | ||
# Customise the issue format to use pull request numbers instead | ||
issue_format = "[#{issue}](https://github.com/pybamm-team/PyBaMM/pull/{issue})" | ||
|
||
[[tool.towncrier.type]] | ||
directory = "feature" | ||
name = "Features" | ||
showcontent = true | ||
|
||
[[tool.towncrier.type]] | ||
directory = "bugfix" | ||
name = "Bug fixes" | ||
showcontent = true | ||
|
||
[[tool.towncrier.type]] | ||
directory = "optimization" | ||
name = "Optimizations" | ||
showcontent = true | ||
|
||
[[tool.towncrier.type]] | ||
directory = "breaking" | ||
name = "Breaking changes" | ||
showcontent = true |