You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@pulsar.apache.org by Yu <li...@apache.org> on 2021/12/13 08:18:40 UTC
PIP 112: Generate Release Notes Automatically
Hi Pulsarers,
As we know[1], there are some issues in the current Pulsar release notes
(RN), for example:
- For Pulsar users
They cannot capture the highlights quickly since the RN is a raw dump of
PRs.
- For Pulsar release managers (RM)
They feel overwhelmed by the **manual** workload of generating RN since it
is created based on git commit messages, while many people do not provide
clear and meaningful info.
It’s time-consuming to clear up all info especially for a major release
with lots of PRs.
If RN is regarded as an afterthought and finished as a last-minute task, it
is likely not written well.
Instead of rushing, treating RN as a part of development not only reduces
RM's workload and makes communication more coordinated,
but also allows more time for us to choose the most valuable highlights
shown to users.
Consequently, the process of the current workflow should be improved.
Therefore, I propose the PIP 112: Generate Release Notes Automatically [2]
and add some initial thoughts and research there.
It is only a draft but I would like to invite you to join us to bring
another major change to Pulsar. I believe this would bring many benefits to
all of us, thanks!
[1] https://lists.apache.org/thread/dl3jb9p3zvlc6ntlkpmxf1m8dw5dcd8z
[2]
https://github.com/apache/pulsar/wiki/PIP-112%3A-Generate-Release-Notes-Automatically
Re: PIP 112: Generate Release Notes Automatically
Posted by Leo <ur...@gmail.com>.
+1
Good idea, I think I can be part of this PIP after I finished upgrading pulsar website.
Thanks,
Leo
> On Dec 13, 2021, at 4:18 PM, Yu <li...@apache.org> wrote:
>
> Hi Pulsarers,
>
> As we know[1], there are some issues in the current Pulsar release notes
> (RN), for example:
>
> - For Pulsar users
> They cannot capture the highlights quickly since the RN is a raw dump of
> PRs.
>
> - For Pulsar release managers (RM)
> They feel overwhelmed by the **manual** workload of generating RN since it
> is created based on git commit messages, while many people do not provide
> clear and meaningful info.
> It’s time-consuming to clear up all info especially for a major release
> with lots of PRs.
>
> If RN is regarded as an afterthought and finished as a last-minute task, it
> is likely not written well.
> Instead of rushing, treating RN as a part of development not only reduces
> RM's workload and makes communication more coordinated,
> but also allows more time for us to choose the most valuable highlights
> shown to users.
> Consequently, the process of the current workflow should be improved.
>
> Therefore, I propose the PIP 112: Generate Release Notes Automatically [2]
> and add some initial thoughts and research there.
> It is only a draft but I would like to invite you to join us to bring
> another major change to Pulsar. I believe this would bring many benefits to
> all of us, thanks!
>
> [1] https://lists.apache.org/thread/dl3jb9p3zvlc6ntlkpmxf1m8dw5dcd8z
> [2]
> https://github.com/apache/pulsar/wiki/PIP-112%3A-Generate-Release-Notes-Automatically
Re: PIP 112: Generate Release Notes Automatically
Posted by Enrico Olivelli <eo...@gmail.com>.
Yu,
thanks a great initiative and I support it at 100%
It looks like you are on your way.
Looking forward to seeing the results !
Enrico
Il giorno lun 13 dic 2021 alle ore 09:19 Yu <li...@apache.org> ha scritto:
> Hi Pulsarers,
>
> As we know[1], there are some issues in the current Pulsar release notes
> (RN), for example:
>
> - For Pulsar users
> They cannot capture the highlights quickly since the RN is a raw dump of
> PRs.
>
> - For Pulsar release managers (RM)
> They feel overwhelmed by the **manual** workload of generating RN since it
> is created based on git commit messages, while many people do not provide
> clear and meaningful info.
> It’s time-consuming to clear up all info especially for a major release
> with lots of PRs.
>
> If RN is regarded as an afterthought and finished as a last-minute task, it
> is likely not written well.
> Instead of rushing, treating RN as a part of development not only reduces
> RM's workload and makes communication more coordinated,
> but also allows more time for us to choose the most valuable highlights
> shown to users.
> Consequently, the process of the current workflow should be improved.
>
> Therefore, I propose the PIP 112: Generate Release Notes Automatically [2]
> and add some initial thoughts and research there.
> It is only a draft but I would like to invite you to join us to bring
> another major change to Pulsar. I believe this would bring many benefits to
> all of us, thanks!
>
> [1] https://lists.apache.org/thread/dl3jb9p3zvlc6ntlkpmxf1m8dw5dcd8z
> [2]
>
> https://github.com/apache/pulsar/wiki/PIP-112%3A-Generate-Release-Notes-Automatically
>
Re: PIP 112: Generate Release Notes Automatically
Posted by Enrico Olivelli <eo...@gmail.com>.
Yu,
thanks a great initiative and I support it at 100%
It looks like you are on your way.
Looking forward to seeing the results !
Enrico
Il giorno lun 13 dic 2021 alle ore 09:19 Yu <li...@apache.org> ha scritto:
> Hi Pulsarers,
>
> As we know[1], there are some issues in the current Pulsar release notes
> (RN), for example:
>
> - For Pulsar users
> They cannot capture the highlights quickly since the RN is a raw dump of
> PRs.
>
> - For Pulsar release managers (RM)
> They feel overwhelmed by the **manual** workload of generating RN since it
> is created based on git commit messages, while many people do not provide
> clear and meaningful info.
> It’s time-consuming to clear up all info especially for a major release
> with lots of PRs.
>
> If RN is regarded as an afterthought and finished as a last-minute task, it
> is likely not written well.
> Instead of rushing, treating RN as a part of development not only reduces
> RM's workload and makes communication more coordinated,
> but also allows more time for us to choose the most valuable highlights
> shown to users.
> Consequently, the process of the current workflow should be improved.
>
> Therefore, I propose the PIP 112: Generate Release Notes Automatically [2]
> and add some initial thoughts and research there.
> It is only a draft but I would like to invite you to join us to bring
> another major change to Pulsar. I believe this would bring many benefits to
> all of us, thanks!
>
> [1] https://lists.apache.org/thread/dl3jb9p3zvlc6ntlkpmxf1m8dw5dcd8z
> [2]
>
> https://github.com/apache/pulsar/wiki/PIP-112%3A-Generate-Release-Notes-Automatically
>
Re: PIP 112: Generate Release Notes Automatically
Posted by Guangning E <eg...@gmail.com>.
+1
Yu <li...@apache.org> 于2021年12月16日周四 18:50写道：
> Hi all,
>
> This is a follow-up to the last email.
>
> Previously, we use markdown files to create issue templates [1].
>
> For the doc_request issue template, I've changed it to a customized issue
> form by adding a YAML form definition file, which is more intuitive and
> easy to use.
>
> Feel free to comment on this PR [2], thanks.
>
> [1] https://github.com/apache/pulsar/tree/master/.github/ISSUE_TEMPLATE
> [2] https://github.com/apache/pulsar/pull/13359
>
> On Tue, Dec 14, 2021 at 9:09 PM Yu Liu <yu...@streamnative.io> wrote:
>
>> Spot on.
>> This also reminds me that we can create custom issue forms by adding YAML
>> form definition files [1], which is more user-friendly and easy to maintain.
>>
>> [1]
>> https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#about-yaml-syntax-for-issue-forms
>>
>>
>> On Tue, Dec 14, 2021 at 2:25 AM Michael Marshall <mm...@apache.org>
>> wrote:
>>
>>> +1 Yu, thank you for putting together this thorough document. This is
>>> a great initiative.
>>>
>>> I think it might help to review and possibly update the PR template as
>>> part of this PIP. For example, the current template does not prompt
>>> authors whether the PR should be mentioned in release notes. Such a
>>> prompt could help committers determine the right labels for a PR.
>>>
>>> Thanks,
>>> Michael
>>>
>>> On Mon, Dec 13, 2021 at 4:56 AM Li Li <ll...@streamnative.io.invalid>
>>> wrote:
>>> >
>>> > +1
>>> >
>>> > Good idea, I think I can be part of this PIP after I finished
>>> upgrading pulsar website.
>>> >
>>> > Thanks,
>>> > LiLi
>>> >
>>> > > On Dec 13, 2021, at 4:18 PM, Yu <li...@apache.org> wrote:
>>> > >
>>> > > Hi Pulsarers,
>>> > >
>>> > > As we know[1], there are some issues in the current Pulsar release
>>> notes
>>> > > (RN), for example:
>>> > >
>>> > > - For Pulsar users
>>> > > They cannot capture the highlights quickly since the RN is a raw
>>> dump of
>>> > > PRs.
>>> > >
>>> > > - For Pulsar release managers (RM)
>>> > > They feel overwhelmed by the **manual** workload of generating RN
>>> since it
>>> > > is created based on git commit messages, while many people do not
>>> provide
>>> > > clear and meaningful info.
>>> > > It’s time-consuming to clear up all info especially for a major
>>> release
>>> > > with lots of PRs.
>>> > >
>>> > > If RN is regarded as an afterthought and finished as a last-minute
>>> task, it
>>> > > is likely not written well.
>>> > > Instead of rushing, treating RN as a part of development not only
>>> reduces
>>> > > RM's workload and makes communication more coordinated,
>>> > > but also allows more time for us to choose the most valuable
>>> highlights
>>> > > shown to users.
>>> > > Consequently, the process of the current workflow should be improved.
>>> > >
>>> > > Therefore, I propose the PIP 112: Generate Release Notes
>>> Automatically [2]
>>> > > and add some initial thoughts and research there.
>>> > > It is only a draft but I would like to invite you to join us to bring
>>> > > another major change to Pulsar. I believe this would bring many
>>> benefits to
>>> > > all of us, thanks!
>>> > >
>>> > > [1] https://lists.apache.org/thread/dl3jb9p3zvlc6ntlkpmxf1m8dw5dcd8z
>>> > > [2]
>>> > >
>>> https://github.com/apache/pulsar/wiki/PIP-112%3A-Generate-Release-Notes-Automatically
>>> >
>>>
>>
Re: PIP 112: Generate Release Notes Automatically
Posted by Yu <li...@apache.org>.
Hi all,
This is a follow-up to the last email.
Previously, we use markdown files to create issue templates [1].
For the doc_request issue template, I've changed it to a customized issue
form by adding a YAML form definition file, which is more intuitive and
easy to use.
Feel free to comment on this PR [2], thanks.
[1] https://github.com/apache/pulsar/tree/master/.github/ISSUE_TEMPLATE
[2] https://github.com/apache/pulsar/pull/13359
On Tue, Dec 14, 2021 at 9:09 PM Yu Liu <yu...@streamnative.io> wrote:
> Spot on.
> This also reminds me that we can create custom issue forms by adding YAML
> form definition files [1], which is more user-friendly and easy to maintain.
>
> [1]
> https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#about-yaml-syntax-for-issue-forms
>
>
> On Tue, Dec 14, 2021 at 2:25 AM Michael Marshall <mm...@apache.org>
> wrote:
>
>> +1 Yu, thank you for putting together this thorough document. This is
>> a great initiative.
>>
>> I think it might help to review and possibly update the PR template as
>> part of this PIP. For example, the current template does not prompt
>> authors whether the PR should be mentioned in release notes. Such a
>> prompt could help committers determine the right labels for a PR.
>>
>> Thanks,
>> Michael
>>
>> On Mon, Dec 13, 2021 at 4:56 AM Li Li <ll...@streamnative.io.invalid>
>> wrote:
>> >
>> > +1
>> >
>> > Good idea, I think I can be part of this PIP after I finished upgrading
>> pulsar website.
>> >
>> > Thanks,
>> > LiLi
>> >
>> > > On Dec 13, 2021, at 4:18 PM, Yu <li...@apache.org> wrote:
>> > >
>> > > Hi Pulsarers,
>> > >
>> > > As we know[1], there are some issues in the current Pulsar release
>> notes
>> > > (RN), for example:
>> > >
>> > > - For Pulsar users
>> > > They cannot capture the highlights quickly since the RN is a raw dump
>> of
>> > > PRs.
>> > >
>> > > - For Pulsar release managers (RM)
>> > > They feel overwhelmed by the **manual** workload of generating RN
>> since it
>> > > is created based on git commit messages, while many people do not
>> provide
>> > > clear and meaningful info.
>> > > It’s time-consuming to clear up all info especially for a major
>> release
>> > > with lots of PRs.
>> > >
>> > > If RN is regarded as an afterthought and finished as a last-minute
>> task, it
>> > > is likely not written well.
>> > > Instead of rushing, treating RN as a part of development not only
>> reduces
>> > > RM's workload and makes communication more coordinated,
>> > > but also allows more time for us to choose the most valuable
>> highlights
>> > > shown to users.
>> > > Consequently, the process of the current workflow should be improved.
>> > >
>> > > Therefore, I propose the PIP 112: Generate Release Notes
>> Automatically [2]
>> > > and add some initial thoughts and research there.
>> > > It is only a draft but I would like to invite you to join us to bring
>> > > another major change to Pulsar. I believe this would bring many
>> benefits to
>> > > all of us, thanks!
>> > >
>> > > [1] https://lists.apache.org/thread/dl3jb9p3zvlc6ntlkpmxf1m8dw5dcd8z
>> > > [2]
>> > >
>> https://github.com/apache/pulsar/wiki/PIP-112%3A-Generate-Release-Notes-Automatically
>> >
>>
>
Re: PIP 112: Generate Release Notes Automatically
Posted by Yu <li...@apache.org>.
Hi all,
This is a follow-up to the last email.
Previously, we use markdown files to create issue templates [1].
For the doc_request issue template, I've changed it to a customized issue
form by adding a YAML form definition file, which is more intuitive and
easy to use.
Feel free to comment on this PR [2], thanks.
[1] https://github.com/apache/pulsar/tree/master/.github/ISSUE_TEMPLATE
[2] https://github.com/apache/pulsar/pull/13359
On Tue, Dec 14, 2021 at 9:09 PM Yu Liu <yu...@streamnative.io> wrote:
> Spot on.
> This also reminds me that we can create custom issue forms by adding YAML
> form definition files [1], which is more user-friendly and easy to maintain.
>
> [1]
> https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#about-yaml-syntax-for-issue-forms
>
>
> On Tue, Dec 14, 2021 at 2:25 AM Michael Marshall <mm...@apache.org>
> wrote:
>
>> +1 Yu, thank you for putting together this thorough document. This is
>> a great initiative.
>>
>> I think it might help to review and possibly update the PR template as
>> part of this PIP. For example, the current template does not prompt
>> authors whether the PR should be mentioned in release notes. Such a
>> prompt could help committers determine the right labels for a PR.
>>
>> Thanks,
>> Michael
>>
>> On Mon, Dec 13, 2021 at 4:56 AM Li Li <ll...@streamnative.io.invalid>
>> wrote:
>> >
>> > +1
>> >
>> > Good idea, I think I can be part of this PIP after I finished upgrading
>> pulsar website.
>> >
>> > Thanks,
>> > LiLi
>> >
>> > > On Dec 13, 2021, at 4:18 PM, Yu <li...@apache.org> wrote:
>> > >
>> > > Hi Pulsarers,
>> > >
>> > > As we know[1], there are some issues in the current Pulsar release
>> notes
>> > > (RN), for example:
>> > >
>> > > - For Pulsar users
>> > > They cannot capture the highlights quickly since the RN is a raw dump
>> of
>> > > PRs.
>> > >
>> > > - For Pulsar release managers (RM)
>> > > They feel overwhelmed by the **manual** workload of generating RN
>> since it
>> > > is created based on git commit messages, while many people do not
>> provide
>> > > clear and meaningful info.
>> > > It’s time-consuming to clear up all info especially for a major
>> release
>> > > with lots of PRs.
>> > >
>> > > If RN is regarded as an afterthought and finished as a last-minute
>> task, it
>> > > is likely not written well.
>> > > Instead of rushing, treating RN as a part of development not only
>> reduces
>> > > RM's workload and makes communication more coordinated,
>> > > but also allows more time for us to choose the most valuable
>> highlights
>> > > shown to users.
>> > > Consequently, the process of the current workflow should be improved.
>> > >
>> > > Therefore, I propose the PIP 112: Generate Release Notes
>> Automatically [2]
>> > > and add some initial thoughts and research there.
>> > > It is only a draft but I would like to invite you to join us to bring
>> > > another major change to Pulsar. I believe this would bring many
>> benefits to
>> > > all of us, thanks!
>> > >
>> > > [1] https://lists.apache.org/thread/dl3jb9p3zvlc6ntlkpmxf1m8dw5dcd8z
>> > > [2]
>> > >
>> https://github.com/apache/pulsar/wiki/PIP-112%3A-Generate-Release-Notes-Automatically
>> >
>>
>
Re: PIP 112: Generate Release Notes Automatically
Posted by Yu Liu <yu...@streamnative.io.INVALID>.
Spot on.
This also reminds me that we can create custom issue forms by adding YAML
form definition files [1], which is more user-friendly and easy to maintain.
[1]
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#about-yaml-syntax-for-issue-forms
On Tue, Dec 14, 2021 at 2:25 AM Michael Marshall <mm...@apache.org>
wrote:
> +1 Yu, thank you for putting together this thorough document. This is
> a great initiative.
>
> I think it might help to review and possibly update the PR template as
> part of this PIP. For example, the current template does not prompt
> authors whether the PR should be mentioned in release notes. Such a
> prompt could help committers determine the right labels for a PR.
>
> Thanks,
> Michael
>
> On Mon, Dec 13, 2021 at 4:56 AM Li Li <ll...@streamnative.io.invalid> wrote:
> >
> > +1
> >
> > Good idea, I think I can be part of this PIP after I finished upgrading
> pulsar website.
> >
> > Thanks,
> > LiLi
> >
> > > On Dec 13, 2021, at 4:18 PM, Yu <li...@apache.org> wrote:
> > >
> > > Hi Pulsarers,
> > >
> > > As we know[1], there are some issues in the current Pulsar release
> notes
> > > (RN), for example:
> > >
> > > - For Pulsar users
> > > They cannot capture the highlights quickly since the RN is a raw dump
> of
> > > PRs.
> > >
> > > - For Pulsar release managers (RM)
> > > They feel overwhelmed by the **manual** workload of generating RN
> since it
> > > is created based on git commit messages, while many people do not
> provide
> > > clear and meaningful info.
> > > It’s time-consuming to clear up all info especially for a major release
> > > with lots of PRs.
> > >
> > > If RN is regarded as an afterthought and finished as a last-minute
> task, it
> > > is likely not written well.
> > > Instead of rushing, treating RN as a part of development not only
> reduces
> > > RM's workload and makes communication more coordinated,
> > > but also allows more time for us to choose the most valuable highlights
> > > shown to users.
> > > Consequently, the process of the current workflow should be improved.
> > >
> > > Therefore, I propose the PIP 112: Generate Release Notes Automatically
> [2]
> > > and add some initial thoughts and research there.
> > > It is only a draft but I would like to invite you to join us to bring
> > > another major change to Pulsar. I believe this would bring many
> benefits to
> > > all of us, thanks!
> > >
> > > [1] https://lists.apache.org/thread/dl3jb9p3zvlc6ntlkpmxf1m8dw5dcd8z
> > > [2]
> > >
> https://github.com/apache/pulsar/wiki/PIP-112%3A-Generate-Release-Notes-Automatically
> >
>
Re: PIP 112: Generate Release Notes Automatically
Posted by Michael Marshall <mm...@apache.org>.
+1 Yu, thank you for putting together this thorough document. This is
a great initiative.
I think it might help to review and possibly update the PR template as
part of this PIP. For example, the current template does not prompt
authors whether the PR should be mentioned in release notes. Such a
prompt could help committers determine the right labels for a PR.
Thanks,
Michael
On Mon, Dec 13, 2021 at 4:56 AM Li Li <ll...@streamnative.io.invalid> wrote:
>
> +1
>
> Good idea, I think I can be part of this PIP after I finished upgrading pulsar website.
>
> Thanks,
> LiLi
>
> > On Dec 13, 2021, at 4:18 PM, Yu <li...@apache.org> wrote:
> >
> > Hi Pulsarers,
> >
> > As we know[1], there are some issues in the current Pulsar release notes
> > (RN), for example:
> >
> > - For Pulsar users
> > They cannot capture the highlights quickly since the RN is a raw dump of
> > PRs.
> >
> > - For Pulsar release managers (RM)
> > They feel overwhelmed by the **manual** workload of generating RN since it
> > is created based on git commit messages, while many people do not provide
> > clear and meaningful info.
> > It’s time-consuming to clear up all info especially for a major release
> > with lots of PRs.
> >
> > If RN is regarded as an afterthought and finished as a last-minute task, it
> > is likely not written well.
> > Instead of rushing, treating RN as a part of development not only reduces
> > RM's workload and makes communication more coordinated,
> > but also allows more time for us to choose the most valuable highlights
> > shown to users.
> > Consequently, the process of the current workflow should be improved.
> >
> > Therefore, I propose the PIP 112: Generate Release Notes Automatically [2]
> > and add some initial thoughts and research there.
> > It is only a draft but I would like to invite you to join us to bring
> > another major change to Pulsar. I believe this would bring many benefits to
> > all of us, thanks!
> >
> > [1] https://lists.apache.org/thread/dl3jb9p3zvlc6ntlkpmxf1m8dw5dcd8z
> > [2]
> > https://github.com/apache/pulsar/wiki/PIP-112%3A-Generate-Release-Notes-Automatically
>
Re: PIP 112: Generate Release Notes Automatically
Posted by Li Li <ll...@streamnative.io.INVALID>.
+1
Good idea, I think I can be part of this PIP after I finished upgrading pulsar website.
Thanks,
LiLi
> On Dec 13, 2021, at 4:18 PM, Yu <li...@apache.org> wrote:
>
> Hi Pulsarers,
>
> As we know[1], there are some issues in the current Pulsar release notes
> (RN), for example:
>
> - For Pulsar users
> They cannot capture the highlights quickly since the RN is a raw dump of
> PRs.
>
> - For Pulsar release managers (RM)
> They feel overwhelmed by the **manual** workload of generating RN since it
> is created based on git commit messages, while many people do not provide
> clear and meaningful info.
> It’s time-consuming to clear up all info especially for a major release
> with lots of PRs.
>
> If RN is regarded as an afterthought and finished as a last-minute task, it
> is likely not written well.
> Instead of rushing, treating RN as a part of development not only reduces
> RM's workload and makes communication more coordinated,
> but also allows more time for us to choose the most valuable highlights
> shown to users.
> Consequently, the process of the current workflow should be improved.
>
> Therefore, I propose the PIP 112: Generate Release Notes Automatically [2]
> and add some initial thoughts and research there.
> It is only a draft but I would like to invite you to join us to bring
> another major change to Pulsar. I believe this would bring many benefits to
> all of us, thanks!
>
> [1] https://lists.apache.org/thread/dl3jb9p3zvlc6ntlkpmxf1m8dw5dcd8z
> [2]
> https://github.com/apache/pulsar/wiki/PIP-112%3A-Generate-Release-Notes-Automatically