Skip to content
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

Merged
merged 4 commits into from
Sep 12, 2018

Conversation

abompard
Copy link
Member

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.

@abompard abompard requested a review from a team as a code owner September 10, 2018 10:20
@abompard abompard force-pushed the towncrier branch 2 times, most recently from 01ffda3 to cbe12d4 Compare September 10, 2018 14:51
Copy link
Member

@jeremycline jeremycline left a 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! ✨ 🍰

When cutting a new release, follow these steps:

* update the version in ``fedora_messaging/__init__.py``
* update the version in ``docs/conf.py``
Copy link
Member

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

Copy link
Member Author

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
Copy link
Member

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.

Copy link
Member Author

@abompard abompard Sep 12, 2018

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.

Copy link
Member

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 😄

abompard and others added 3 commits September 12, 2018 10:56
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-io
Copy link

codecov-io commented Sep 12, 2018

Codecov Report

Merging #67 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1b6d6dc...1ad87f2. Read the comment docs.

jeremycline
jeremycline previously approved these changes Sep 12, 2018
Copy link
Member

@jeremycline jeremycline left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✨ 🍰 :shipit:

Signed-off-by: Aurélien Bompard <aurelien@bompard.org>
@abompard abompard merged commit f49771c into fedora-infra:master Sep 12, 2018
@abompard abompard deleted the towncrier branch September 12, 2018 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants