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

KAFKA-3851: Automate release notes and include links to upgrade notes for release and most recent docs to forward users of older releases to newest docs. #1670

Closed
wants to merge 2 commits into from

Conversation

Projects
None yet
3 participants
@ewencp
Copy link
Contributor

commented Jul 27, 2016

No description provided.

KAFKA-3851: Automate release notes and include links to upgrade notes…
… for release and most recent docs to forward users of older releases to newest docs.
@ewencp

This comment has been minimized.

Copy link
Contributor Author

commented Jul 27, 2016

@ijuma @gwenshap Script to automate the generation of the release notes. It uses JIRA python library with a straightforward script to automate the release notes step from https://cwiki.apache.org/confluence/display/KAFKA/Release+Process and lets us easily customize the output. I've added some simple links to upgrade docs for the version (which currently assume we have only "major" version release URLs, i.e. 0.10.0, and to the most recent docs and top-level project URL.

We'll just replace the current steps on the release process wiki with something like:

Prepare release

  • Go to JIRA, move all unresolved jiras with "Fix versions" of 0.10.0.0 to future releases.
  • Run ./release_notes.py <version> > RELEASE_NOTES.html where <version> is the release number like 0.10.0.0. It will fail if you have any unresolved JIRAs still in the release, listing the JIRAs that still need to be addressed. Otherwise, double check that the output in RELEASE_NOTES.html looks ok for release.
  • Upload the release notes to home.apache.org

from jira import JIRA
import itertools, sys

This comment has been minimized.

Copy link
@junrao

junrao Jul 27, 2016

Contributor

Could we add some comments on what the tool does?

This comment has been minimized.

Copy link
@ewencp

ewencp Jul 27, 2016

Author Contributor

Added a docstring to the top of the script.

sys.exit(1)

# Get list of (issue type, [issues]) sorted by the issue ID type's , with each subset of issues sorted by their key so they are in
# increasing order of bug #

This comment has been minimized.

Copy link
@ijuma

ijuma Jul 27, 2016

Contributor

Would it make sense to list features and improvements before the rest?

This comment has been minimized.

Copy link
@ewencp

ewencp Jul 27, 2016

Author Contributor

To be honest, I considered removing the categories altogether. I actually can't tell if the ordering from JIRA is meaningful. It doesn't correspond to alphabetical, issue type ID, or anything else I could figure out. And unfortunately since JIRA is super configurable, you can't rely on the exact set of issue types.

I've changed the sorting so we'll prioritize the two you mentioned and the rest go in the order of their issue type IDs. We can add further customization if we want to refine the ordering of other types too.


unresolved_issues = [issue for issue in issues if issue.fields.resolution is None]
if unresolved_issues:
for issue in unresolved_issues:

This comment has been minimized.

Copy link
@ijuma

ijuma Jul 27, 2016

Contributor

I think it would be good to include a message giving context before we start listing unresolved issues.

This comment has been minimized.

Copy link
@ewencp

ewencp Jul 27, 2016

Author Contributor

Added

@ijuma

This comment has been minimized.

Copy link
Contributor

commented Jul 27, 2016

Nice one @ewencp. I left a couple of minor comments, looks great otherwise.

@ewencp

This comment has been minimized.

Copy link
Contributor Author

commented Jul 27, 2016

@ijuma Addressed review comments, ready for another look.

@ijuma

This comment has been minimized.

Copy link
Contributor

commented Jul 27, 2016

LGTM, merging it to trunk and 0.10.0 branches.

asfgit pushed a commit that referenced this pull request Jul 27, 2016

KAFKA-3851; Automate release notes and include links to upgrade notes…
… for release and most recent docs to forward users of older releases to newest docs.

Author: Ewen Cheslack-Postava <me@ewencp.org>

Reviewers: Jun Rao <junrao@gmail.com>, Ismael Juma <ismael@juma.me.uk>

Closes #1670 from ewencp/kafka-3851-automate-release-notes

(cherry picked from commit d5c821c)
Signed-off-by: Ismael Juma <ismael@juma.me.uk>

@asfgit asfgit closed this in d5c821c Jul 27, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.