Skip to content
This repository has been archived by the owner on Jul 8, 2022. It is now read-only.

Add CHANGELOG.md #519

Merged
merged 13 commits into from
Mar 29, 2019
Merged

Add CHANGELOG.md #519

merged 13 commits into from
Mar 29, 2019

Conversation

bourtemb
Copy link
Member

based on Keep a Changelog
Add more details about changes occurring since Tango 9.2.5 and potential impact on user experience as suggested by #509

@bourtemb
Copy link
Member Author

RELEASE_NOTES file is kept for the moment but should probably be replaced with something less technical and giving a better summary of the main changes, asking users to refer to the CHANGELOG.md file if they want more technical details.
I think release notes should also focus on the changes between stable releases.
The user does not care if a bug was introduced in 9.2.9 and fixed in 9.3.3 if this bug was not present in 9.2.5.
We could actually create a wiki page for the Release Notes when there will be a new stable release to have them in a more friendly format where we could eventually insert snapshots and images.

@bourtemb bourtemb force-pushed the AddCHANGELOG branch 2 times, most recently from f040856 to 21ed842 Compare March 1, 2019 16:26
@bourtemb bourtemb mentioned this pull request Mar 13, 2019
Closed
14 tasks
@bourtemb bourtemb requested a review from Ingvord March 14, 2019 09:07
@bourtemb
Copy link
Member Author

I propose to go ahead and to do a cppTango 9.3.3 release, flagged as pre-release on Github.
Before to tag this new version, I'd like to merge this Pull Request listing all the changes.
The exact date of the release will have to be updated on CHANGELOG.md and RELEASE_NOTES.md when we will create the release.

@Ingvord
Copy link
Member

Ingvord commented Mar 14, 2019

We could actually create a wiki page for the Release Notes when there will be a new stable release to have them in a more friendly format where we could eventually insert snapshots and images.

IMHO we should use GitHub releases for RELEASE_NOTES. Seems more logical for me than a dedicated wiki page. When you go to releases it lists all the releases with some details as in Waltz for instance.

@bourtemb
Copy link
Member Author

IMHO we should use GitHub releases for RELEASE_NOTES. Seems more logical for me than a dedicated wiki page. When you go to releases it lists all the releases with some details as in Waltz for instance.

The release notes should be on the Github release page I agree with you. And your example with Waltz shows that there is no problem to include images if needed on this Github release page.

@bourtemb bourtemb requested a review from andygotz March 14, 2019 09:38
@Ingvord Ingvord mentioned this pull request Mar 27, 2019
Closed
18 tasks
bourtemb added 13 commits March 28, 2019 16:58
@bourtemb
Added CHANGELOG.md
f025e62 
This file is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
List changes since cppTango 9.2.5.
Changes with potential compatibility issues are documented as suggested in tango-controls#509 and are in bold.
@bourtemb
Add links to issues and PRs in CHANGELOG.md
9107271
@bourtemb
Update CHANGELOG.md
3d1acba 
with references to tango-controls#508,tango-controls#516,tango-controls#518,tango-controls#520,tango-controls#521,tango-controls#522,tango-controls#523,tango-controls#529,tango-controls#531,tango-controls#533,tango-controls#537
@bourtemb
Update CHANGELOG.md with tango-controls#517
f386571
@bourtemb
Update CHANGELOG.md. Add link for issue 395
075898d
@bourtemb
Moved 2 items from Fixed to Changed section
b62caad 
Added a warning about the event subscription change sleep reduction
@bourtemb
First version of the release notes for cppTango 9.3.3
7e540ad 
Rename RELEASE_NOTES in RELEASE_NOTES.md.
The previous RELEASE_NOTES content has been moved to CHANGELOG.md file.
@bourtemb
Added reference to cppTango#539
79b17b0 
Preparation for cppTango 9.3.3 release
@bourtemb
Update CHANGELOG and RELEASE_NOTES with tango-controls#541 and tango-…
82d87f5 
…controls#542
@bourtemb
Reword one item in CHANGELOG.md and RELEASE_NOTES.md
545dee7
@bourtemb
Update CHANGELOG.md with tango-controls#544, tango-controls#546 and t…
cb86e9a 
…ango-controls#549
@bourtemb
Add reference to tango-controls#532
fa75fd5 
Add 9.3.3 release date
@bourtemb
Add 9.3.3 release date
f5c59ad
@bourtemb
Copy link
Member Author

bourtemb commented Mar 28, 2019 •
edited
Loading

@Ingvord, thanks for your review.
I added 5 small commits since you last reviewed this PR.
Could you please review again this PR and if you agree, could you please merge it (using squash & merge method)?
I'd like to tag the release tomorrow (Friday 29).
As I already wrote about the RELEASE_NOTES file, IMHO it is good to keep it as a file provided with the source code too. And it's easier to proceed like that when preparing the release so we can prepare and discuss the contents of the release notes in a Pull Request.
I agree with you when you write "it should be on the Github release page".
I simply propose to copy the content of this file in the Github release page when the release is created.

@Ingvord Ingvord self-requested a review March 29, 2019 08:48
@Ingvord Ingvord merged commit 9c8837f into tango-controls:tango-9-lts Mar 29, 2019
@bourtemb bourtemb mentioned this pull request Mar 29, 2019
Closed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@andygotz andygotz Awaiting requested review from andygotz

@Ingvord Ingvord Awaiting requested review from Ingvord

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@bourtemb @Ingvord