Skip to content

Commit

Permalink
Merge pull request #13 from njsmith/towncrier
Browse files Browse the repository at this point in the history
Use towncrier for release notes
  • Loading branch information
njsmith committed Aug 3, 2017
2 parents 8e25afa + 9bebcde commit df64e63
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 7 deletions.
16 changes: 9 additions & 7 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,19 +53,21 @@ API reference
Change history
==============

v0.2.0 (2017-08-02)
-------------------
.. towncrier release notes start
* Broke and re-did almost the entire public API. Sorry! Let's just
Trustme v0.2.0 (2017-08-02)
---------------------------

- Broke and re-did almost the entire public API. Sorry! Let's just
pretend v0.1.0 never happened.

* Hey there are docs now though, that should be worth something right?
- Hey there are docs now though, that should be worth something right?


v0.1.0 (2017-07-18)
-------------------
Trustme v0.1.0 (2017-07-18)
---------------------------

* Initial release
- Initial release


Acknowledgements
Expand Down
Empty file added newsfragments/.gitkeep
Empty file.
1 change: 1 addition & 0 deletions newsfragments/12.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Use towncrier for release notes
18 changes: 18 additions & 0 deletions pyproject.toml
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}>`__"

0 comments on commit df64e63

Please sign in to comment.