Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Add towncrier #2873
Tobotimus left a comment
Just a few things:
Probably need a few extra full stops at the end of sentences in section 4.7. Also, you might need to update the table of contents at the top with the new section + the updated section numbers.
Something I wondered about was what the filename should look like if the PR doesn't have a corresponding issue, or what the PR author should do if they're closing multiple issues at once (multiple changelog files?).
I might need to make this clearer for further use, but to add a dependency:
In this case, since
New make recipe
If it closes multiple issues, make a file for each issue it closes.
If there's no corresponding issue, the PR can be opened and the PR number used instead. (requires the towncrier entry to be created after the PR is opened)
Additionally, if there need to be multiple lines in the same section for the same issue or PR, this can be done as well.
The full spec for a filename with the current settings is
I'll go ahead and make some additional changes here in a bit. to address the other issues. I'm actually going to remove the changelog check from the makefile and have tox invoke the bash script directly while on travis
I've made the fragment check only run on Travis for now. (and fixed the depedency bit)
I've chosen to leave it in the docs section as changelogs as used here really are documentation.
I'll go back and improve some of the scripting here to make it more useful locally later on, but this is really just for a check existing to help support process.
Went ahead and made the changelog fragment check attempt to use an env var
Making this more useful probably means there should be a corresponding windows entry for the makefile at some point, but my priority on this is getting this working for Travis.