Add release notes to Github release tag

Description

Release notes for 1.6.1 went to Synapse announcements - I think they should be added directly to the Github release tag, and then linked to the announcement in the discussion forum. They should also be visible somehow in the Python docs page (at least the version with link to release notes).

Environment

None

Activity

Show:
Kenneth Daily
June 27, 2017, 5:28 PM

Yay! Is there documentation of the process of generating these (such that they match other potential sources of information, when/how they should be added, etc)? I suppose either in our internal confluence, or in the Github CONTRIBUTING or README.

Meredith Slota
June 28, 2017, 7:04 PM

Looks great, thank you . Could you clarify your request?

Kenneth Daily
June 28, 2017, 7:10 PM

In the future, how does one get the list of Jira issues and formats it in the same way, what info do we put there? A style and formatting guide for what goes into the release notes, where it comes from, etc.

Side note - why is it the client 1.7 release notes, but the version is 1.7.1?

Meredith Slota
June 28, 2017, 7:15 PM

For context: Ziming went through all the issues that were tagged with fixVersion = py-1.7 and omitted the JIRA tickets that were closed as "Duplicate" or "Won't Do" or "Won't Fix". The rest were grouped into new features vs. bug fixes, and Ziming also wrote a summary statement. I am not certain if we have done it exactly like this previously, but this seems to be a good standard going forward.

We also posted the same release notes as an Announcement in the Announcements forum so it showed up on Synapse. Duplicate content, but for this purpose it's ok (for now).

Meredith Slota
June 28, 2017, 7:19 PM

Whoops, was typing while you commented. As for future versions, I think we're reverse engineer the instructions based on what Ziming did – to get the list of issues, filter by the fixVersion (e.g. next version is fixVersion = py-1.8).

I am not totally sure why it's not v1.7.0, that's a good question.

Assignee

Ziming Dong

Reporter

Kenneth Daily

Labels

None

Validator

Meredith Slota

Development Area

None

Release Version History

None

Fix versions

Priority

Major
Configure