-
-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #13 from njsmith/towncrier
Use towncrier for release notes
- Loading branch information
Showing
4 changed files
with
28 additions
and
7 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
Empty file.
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 @@ | ||
Use towncrier for release notes |
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,18 @@ | ||
[tool.towncrier] | ||
# Usage: | ||
# - PRs should drop a file like "issuenumber.feature" in newsfragments | ||
# (or "bugfix", "doc", "removal", "misc"; misc gets no text, we can | ||
# customize this) | ||
# - At release time after bumping version number, run: towncrier | ||
# (or towncrier --draft) | ||
# - Make sure to use a version with the PRs mentioned below merged. | ||
# Right now on my laptop it's | ||
# PYTHONPATH=~/src/towncrier/src ~/src/towncrier/bin/towncrier | ||
# with the merge-64-66 branch checked out. | ||
package = "trustme" | ||
filename = "docs/source/index.rst" | ||
directory = "newsfragments" | ||
# Requires https://github.com/hawkowl/towncrier/pull/64 | ||
underlines = ["-", "~", "^"] | ||
# Requires https://github.com/hawkowl/towncrier/pull/66 | ||
issue_format = "`#{issue} <https://github.com/python-trio/trustme/issues/{issue}>`__" |