-
Notifications
You must be signed in to change notification settings - Fork 52
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
Use towncrier to generate the changelog #67
Conversation
01ffda3
to
cbe12d4
Compare
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.
I made two small commits on top of this to add the package to the dev requirements and to set the docs version automatically. Let me know what you think and revert whatever you don't like :)
If the get-authors.py script needs to be called before the release (it seems like it's supposed to be?) then we should add a note to the release process, too.
This looks super slick! ✨ 🍰
docs/contributing.rst
Outdated
When cutting a new release, follow these steps: | ||
|
||
* update the version in ``fedora_messaging/__init__.py`` | ||
* update the version in ``docs/conf.py`` |
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.
I have some fanciness to pull the version in the docs from init.py, I'll push a commit to this PR
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.
That that looks cool. So this line isn't necessary anymore.
@@ -0,0 +1,17 @@ | |||
#!/usr/bin/env python3 |
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.
Do we need to run this before towncrier to generate the authors for a release? If so it'd be good to note that in the release documentation. It'd be cool to auto-generate the contributors to issues and PRs by looking at the news items and querying the PRs/issues for users as well, since bug reports are valuable contributions.
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.
My original intention was that new .author
files would be added as part of the PR (just like the news file). But I left this script in case we forgot people and wanted to check before the release. It shouldn't be a requirement, and it needs to be improved before we can use it that way, since at the moment it checks the whole git history, and not since the last tag.
I agree it'd be cool to get contributors from the GitHub API too, I'll see if I can add it in the future.
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.
Cool, sounds good to me 😄
Signed-off-by: Aurélien Bompard <aurelien@bompard.org>
Signed-off-by: Jeremy Cline <jcline@redhat.com>
Signed-off-by: Jeremy Cline <jcline@redhat.com>
Codecov Report
@@ Coverage Diff @@
## master #67 +/- ##
=======================================
Coverage 93.08% 93.08%
=======================================
Files 11 11
Lines 810 810
Branches 113 113
=======================================
Hits 754 754
Misses 37 37
Partials 19 19 Continue to review full report at Codecov.
|
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.
✨ 🍰
Signed-off-by: Aurélien Bompard <aurelien@bompard.org>
Towncrier lets us generate release notes in a much more convenient way than what we currently do. Each PR just has to create a file with the line that should end up in the release notes, and the
changelog.rst
file can be automatically generated before each release.I have added documentation in the
contributing.rst
file for more usage info.@jeremycline I would also like you to verify that the releasing process I have documented in
contributing.rst
is correct, please.