You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cloudstack.apache.org by Wido den Hollander <wi...@widodh.nl> on 2018/06/19 21:00:50 UTC
Working with a 'PendingReleaseNotes' file
Hi,
At the Ceph project we work with a Pending Release Notes [0].
The idea is that if a developer writes a new feature or fixes something
that changes functionality (or adds one) she/he also updates the
PendingReleaseNotes file.
That way when a new version is released it's easier for the Release
Manager to know what to highlight.
Although we can try to get everything from Jira and Github Issues it
might be difficult to use the proper wording.
On every release the files is cleared and people start to add again.
Would this be something which could benefit CloudStack and make the
release notes easier and more complete?
Wido
[0]: https://github.com/ceph/ceph/blob/master/PendingReleaseNotes
Re: Working with a 'PendingReleaseNotes' file
Posted by Wido den Hollander <wi...@widodh.nl>.
On 06/22/2018 07:52 AM, Rohit Yadav wrote:
> Looks like a good idea, +1.
>
I've opened a PR for this: https://github.com/apache/cloudstack/pull/2723
If we want to go through with this we should merge the PR and then
update the Github template for a PR as well to make this a new checkbox.
Other places of documentation which we need to update?
Wido
>
> - Rohit
>
> <https://cloudstack.apache.org>
>
>
>
> ________________________________
> From: Wido den Hollander <wi...@widodh.nl>
> Sent: Friday, June 22, 2018 12:13:49 AM
> To: dev@cloudstack.apache.org; Daan Hoogland
> Cc: Rafael Weingärtner
> Subject: Re: Working with a 'PendingReleaseNotes' file
>
>
>
> On 06/21/2018 05:13 PM, Daan Hoogland wrote:
>> Wido, I like the idea that we can generate from git what has happened since
>> last time. I also recognise that we don't do that properly all the time.
>
> True. But a bunch of commits don't akways tell the exact story. Well,
> they do, but not for the end-user.
>
>> What this comes down to is discipline, however we implement it. Deciding if
>> a change is big enough would be up to both the author and the reviewer and
>> we could ask for a comment tagged "Release Note:" as well. Just saying many
>> ways to do this. going with your idea from the ceph community. Where do we
>> move the release notes when the release is out? and when? (release
>> candidate/first thing after approval/part of the release commit)
>>
>
> You would move it to a file called "ReleaseNotes" afterwards, that is
> done by the Release Manager.
>
> Wido
>
>
> rohit.yadav@shapeblue.com
> www.shapeblue.com
> 53 Chandos Place, Covent Garden, London WC2N 4HSUK
> @shapeblue
>
>
>
>> On Wed, Jun 20, 2018 at 11:05 AM, Wido den Hollander <wi...@widodh.nl> wrote:
>>
>>>
>>>
>>> On 06/20/2018 07:53 AM, Rafael Weingärtner wrote:
>>>> It seems so. It can then be a part of the PR. I mean, in the PR we could
>>>> require a commit that updates this file.
>>>
>>> Yes, that would be the thing. When you send a PR with a change that is
>>> 'big enough' you also include updating the Pending Release Notes file.
>>>
>>>> Of course, we need to discuss if all PRs should update it, or only
>>>> important things should go in.
>>>>
>>>
>>> I think only important things and that it's up to the developer to guess
>>> if it's important enough to go into the PendingReleaseNotes file.
>>>
>>> Wido
>>>
>>>> +1
>>>>
>>>> On Tue, Jun 19, 2018 at 11:00 PM, Wido den Hollander <wi...@widodh.nl>
>>> wrote:
>>>>
>>>>> Hi,
>>>>>
>>>>> At the Ceph project we work with a Pending Release Notes [0].
>>>>>
>>>>> The idea is that if a developer writes a new feature or fixes something
>>>>> that changes functionality (or adds one) she/he also updates the
>>>>> PendingReleaseNotes file.
>>>>>
>>>>> That way when a new version is released it's easier for the Release
>>>>> Manager to know what to highlight.
>>>>>
>>>>> Although we can try to get everything from Jira and Github Issues it
>>>>> might be difficult to use the proper wording.
>>>>>
>>>>> On every release the files is cleared and people start to add again.
>>>>>
>>>>> Would this be something which could benefit CloudStack and make the
>>>>> release notes easier and more complete?
>>>>>
>>>>> Wido
>>>>>
>>>>> [0]: https://github.com/ceph/ceph/blob/master/PendingReleaseNotes
>>>>>
>>>>
>>>>
>>>>
>>>
>>
>>
>>
>
Re: Working with a 'PendingReleaseNotes' file
Posted by Rohit Yadav <ro...@shapeblue.com>.
Looks like a good idea, +1.
- Rohit
<https://cloudstack.apache.org>
________________________________
From: Wido den Hollander <wi...@widodh.nl>
Sent: Friday, June 22, 2018 12:13:49 AM
To: dev@cloudstack.apache.org; Daan Hoogland
Cc: Rafael Weingärtner
Subject: Re: Working with a 'PendingReleaseNotes' file
On 06/21/2018 05:13 PM, Daan Hoogland wrote:
> Wido, I like the idea that we can generate from git what has happened since
> last time. I also recognise that we don't do that properly all the time.
True. But a bunch of commits don't akways tell the exact story. Well,
they do, but not for the end-user.
> What this comes down to is discipline, however we implement it. Deciding if
> a change is big enough would be up to both the author and the reviewer and
> we could ask for a comment tagged "Release Note:" as well. Just saying many
> ways to do this. going with your idea from the ceph community. Where do we
> move the release notes when the release is out? and when? (release
> candidate/first thing after approval/part of the release commit)
>
You would move it to a file called "ReleaseNotes" afterwards, that is
done by the Release Manager.
Wido
rohit.yadav@shapeblue.com
www.shapeblue.com
53 Chandos Place, Covent Garden, London WC2N 4HSUK
@shapeblue
> On Wed, Jun 20, 2018 at 11:05 AM, Wido den Hollander <wi...@widodh.nl> wrote:
>
>>
>>
>> On 06/20/2018 07:53 AM, Rafael Weingärtner wrote:
>>> It seems so. It can then be a part of the PR. I mean, in the PR we could
>>> require a commit that updates this file.
>>
>> Yes, that would be the thing. When you send a PR with a change that is
>> 'big enough' you also include updating the Pending Release Notes file.
>>
>>> Of course, we need to discuss if all PRs should update it, or only
>>> important things should go in.
>>>
>>
>> I think only important things and that it's up to the developer to guess
>> if it's important enough to go into the PendingReleaseNotes file.
>>
>> Wido
>>
>>> +1
>>>
>>> On Tue, Jun 19, 2018 at 11:00 PM, Wido den Hollander <wi...@widodh.nl>
>> wrote:
>>>
>>>> Hi,
>>>>
>>>> At the Ceph project we work with a Pending Release Notes [0].
>>>>
>>>> The idea is that if a developer writes a new feature or fixes something
>>>> that changes functionality (or adds one) she/he also updates the
>>>> PendingReleaseNotes file.
>>>>
>>>> That way when a new version is released it's easier for the Release
>>>> Manager to know what to highlight.
>>>>
>>>> Although we can try to get everything from Jira and Github Issues it
>>>> might be difficult to use the proper wording.
>>>>
>>>> On every release the files is cleared and people start to add again.
>>>>
>>>> Would this be something which could benefit CloudStack and make the
>>>> release notes easier and more complete?
>>>>
>>>> Wido
>>>>
>>>> [0]: https://github.com/ceph/ceph/blob/master/PendingReleaseNotes
>>>>
>>>
>>>
>>>
>>
>
>
>
Re: Working with a 'PendingReleaseNotes' file
Posted by Wido den Hollander <wi...@widodh.nl>.
On 06/21/2018 05:13 PM, Daan Hoogland wrote:
> Wido, I like the idea that we can generate from git what has happened since
> last time. I also recognise that we don't do that properly all the time.
True. But a bunch of commits don't akways tell the exact story. Well,
they do, but not for the end-user.
> What this comes down to is discipline, however we implement it. Deciding if
> a change is big enough would be up to both the author and the reviewer and
> we could ask for a comment tagged "Release Note:" as well. Just saying many
> ways to do this. going with your idea from the ceph community. Where do we
> move the release notes when the release is out? and when? (release
> candidate/first thing after approval/part of the release commit)
>
You would move it to a file called "ReleaseNotes" afterwards, that is
done by the Release Manager.
Wido
> On Wed, Jun 20, 2018 at 11:05 AM, Wido den Hollander <wi...@widodh.nl> wrote:
>
>>
>>
>> On 06/20/2018 07:53 AM, Rafael Weingärtner wrote:
>>> It seems so. It can then be a part of the PR. I mean, in the PR we could
>>> require a commit that updates this file.
>>
>> Yes, that would be the thing. When you send a PR with a change that is
>> 'big enough' you also include updating the Pending Release Notes file.
>>
>>> Of course, we need to discuss if all PRs should update it, or only
>>> important things should go in.
>>>
>>
>> I think only important things and that it's up to the developer to guess
>> if it's important enough to go into the PendingReleaseNotes file.
>>
>> Wido
>>
>>> +1
>>>
>>> On Tue, Jun 19, 2018 at 11:00 PM, Wido den Hollander <wi...@widodh.nl>
>> wrote:
>>>
>>>> Hi,
>>>>
>>>> At the Ceph project we work with a Pending Release Notes [0].
>>>>
>>>> The idea is that if a developer writes a new feature or fixes something
>>>> that changes functionality (or adds one) she/he also updates the
>>>> PendingReleaseNotes file.
>>>>
>>>> That way when a new version is released it's easier for the Release
>>>> Manager to know what to highlight.
>>>>
>>>> Although we can try to get everything from Jira and Github Issues it
>>>> might be difficult to use the proper wording.
>>>>
>>>> On every release the files is cleared and people start to add again.
>>>>
>>>> Would this be something which could benefit CloudStack and make the
>>>> release notes easier and more complete?
>>>>
>>>> Wido
>>>>
>>>> [0]: https://github.com/ceph/ceph/blob/master/PendingReleaseNotes
>>>>
>>>
>>>
>>>
>>
>
>
>
Re: Working with a 'PendingReleaseNotes' file
Posted by Daan Hoogland <da...@gmail.com>.
Wido, I like the idea that we can generate from git what has happened since
last time. I also recognise that we don't do that properly all the time.
What this comes down to is discipline, however we implement it. Deciding if
a change is big enough would be up to both the author and the reviewer and
we could ask for a comment tagged "Release Note:" as well. Just saying many
ways to do this. going with your idea from the ceph community. Where do we
move the release notes when the release is out? and when? (release
candidate/first thing after approval/part of the release commit)
On Wed, Jun 20, 2018 at 11:05 AM, Wido den Hollander <wi...@widodh.nl> wrote:
>
>
> On 06/20/2018 07:53 AM, Rafael Weingärtner wrote:
> > It seems so. It can then be a part of the PR. I mean, in the PR we could
> > require a commit that updates this file.
>
> Yes, that would be the thing. When you send a PR with a change that is
> 'big enough' you also include updating the Pending Release Notes file.
>
> > Of course, we need to discuss if all PRs should update it, or only
> > important things should go in.
> >
>
> I think only important things and that it's up to the developer to guess
> if it's important enough to go into the PendingReleaseNotes file.
>
> Wido
>
> > +1
> >
> > On Tue, Jun 19, 2018 at 11:00 PM, Wido den Hollander <wi...@widodh.nl>
> wrote:
> >
> >> Hi,
> >>
> >> At the Ceph project we work with a Pending Release Notes [0].
> >>
> >> The idea is that if a developer writes a new feature or fixes something
> >> that changes functionality (or adds one) she/he also updates the
> >> PendingReleaseNotes file.
> >>
> >> That way when a new version is released it's easier for the Release
> >> Manager to know what to highlight.
> >>
> >> Although we can try to get everything from Jira and Github Issues it
> >> might be difficult to use the proper wording.
> >>
> >> On every release the files is cleared and people start to add again.
> >>
> >> Would this be something which could benefit CloudStack and make the
> >> release notes easier and more complete?
> >>
> >> Wido
> >>
> >> [0]: https://github.com/ceph/ceph/blob/master/PendingReleaseNotes
> >>
> >
> >
> >
>
--
Daan
Re: Working with a 'PendingReleaseNotes' file
Posted by Wido den Hollander <wi...@widodh.nl>.
On 06/20/2018 07:53 AM, Rafael Weingärtner wrote:
> It seems so. It can then be a part of the PR. I mean, in the PR we could
> require a commit that updates this file.
Yes, that would be the thing. When you send a PR with a change that is
'big enough' you also include updating the Pending Release Notes file.
> Of course, we need to discuss if all PRs should update it, or only
> important things should go in.
>
I think only important things and that it's up to the developer to guess
if it's important enough to go into the PendingReleaseNotes file.
Wido
> +1
>
> On Tue, Jun 19, 2018 at 11:00 PM, Wido den Hollander <wi...@widodh.nl> wrote:
>
>> Hi,
>>
>> At the Ceph project we work with a Pending Release Notes [0].
>>
>> The idea is that if a developer writes a new feature or fixes something
>> that changes functionality (or adds one) she/he also updates the
>> PendingReleaseNotes file.
>>
>> That way when a new version is released it's easier for the Release
>> Manager to know what to highlight.
>>
>> Although we can try to get everything from Jira and Github Issues it
>> might be difficult to use the proper wording.
>>
>> On every release the files is cleared and people start to add again.
>>
>> Would this be something which could benefit CloudStack and make the
>> release notes easier and more complete?
>>
>> Wido
>>
>> [0]: https://github.com/ceph/ceph/blob/master/PendingReleaseNotes
>>
>
>
>
Re: Working with a 'PendingReleaseNotes' file
Posted by Rafael Weingärtner <ra...@gmail.com>.
It seems so. It can then be a part of the PR. I mean, in the PR we could
require a commit that updates this file.
Of course, we need to discuss if all PRs should update it, or only
important things should go in.
+1
On Tue, Jun 19, 2018 at 11:00 PM, Wido den Hollander <wi...@widodh.nl> wrote:
> Hi,
>
> At the Ceph project we work with a Pending Release Notes [0].
>
> The idea is that if a developer writes a new feature or fixes something
> that changes functionality (or adds one) she/he also updates the
> PendingReleaseNotes file.
>
> That way when a new version is released it's easier for the Release
> Manager to know what to highlight.
>
> Although we can try to get everything from Jira and Github Issues it
> might be difficult to use the proper wording.
>
> On every release the files is cleared and people start to add again.
>
> Would this be something which could benefit CloudStack and make the
> release notes easier and more complete?
>
> Wido
>
> [0]: https://github.com/ceph/ceph/blob/master/PendingReleaseNotes
>
--
Rafael Weingärtner