-
Notifications
You must be signed in to change notification settings - Fork 124
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Simple configuration for Keep a Changelog style changelogs #693
Conversation
9ef9fcd
to
4e10434
Compare
4e10434
to
2b9fd49
Compare
Thanks Matteo for the PR. Let me know when the PR is ready for review and I will do a full review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Many thanks for the fix.
The change looks good.
A few minor comments.
The major comment is on what is checked/asserted by the tests.
I think that we should check more than just the exit code for build --draft
.
Thanks again!
for more information, see https://pre-commit.ci
""" | ||
) | ||
self.assertEqual(0, result.exit_code, result.output) | ||
self.assertEqual(expected, news, news) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can leave it as it is. Just a sidenote
I am not sure that it helps to repeate the actual value here.
Of we want to show full diff, we can set unittest.TestCase.maxDiff
self.assertEqual(expected, news, news) | |
self.assertEqual(expected, news, news) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Stellar work! I will merge.
Thanks again
Description
Fixes #691
This PR simplifies the configuration for Markdown changelog files. The
directory
key is inferred from thename
key, andshowcontent
defaults totrue
.Checklist
src/towncrier/newsfragments/
. Briefly describe yourchanges, with information useful to end users. Your change will be included in the public release notes.
docs/tutorial.rst
is still up-to-date.docs/cli.rst
reflects those changes.docs/configuration.rst
reflects those changes.