Openembedded Core Discussions
 help / color / mirror / Atom feed
* 3.0 release notes / migration guide
@ 2019-10-02 22:20 Paul Eggleton
  2019-10-02 22:44 ` akuster808
  0 siblings, 1 reply; 4+ messages in thread
From: Paul Eggleton @ 2019-10-02 22:20 UTC (permalink / raw)
  To: openembedded-core, yocto

Hi folks

So it's that time again - we need to start building up the raw material for 
the release notes and migration guide for the upcoming 3.0 release, and I'd 
like to request some help with some parts of it - read on for details.

For the migration guide we have a wiki page serving as a staging area:

  https://wiki.yoctoproject.org/wiki/FutureMigrationGuide

Things that should go in the migration guide: *anything* in the release that 
would require someone who is upgrading to take some form of action (i.e. 
change their configuration / recipes / etc.) Help with this from people who 
implemented the changes or have already thought about / dealt with their 
impact would be much appreciated.

There is a process where I look through all the commits since the last release 
and pull out the ones that need to be mentioned in some form - other than the 
migration guide items, the following needs to be gathered for the release 
notes:

1) Features - new functionality. We need to capture what the feature is and 
hopefully express the impact to the user succinctly.

2) Recipe upgrades - straightforward

3) CVE fixes - fairly straightforward, I just look for commits that explicitly 
mention "CVE". If I can easily do so I'll also note where a recipe upgrade 
fixes a CVE, but that isn't often readily available information.

4) Known issues - generally this is difficult to get from the commits since we 
either find out about them after the commit that introduced the issue, or we 
don't know that they aren't addressed until right at the end of the release. 
We don't want to note *all* open bugs, but if there's something that the user 
is likely to hit that wasn't an issue in the previous release then we should 
note it.

For the release notes I need help with #4 and #1 in particular, so if you know 
about anything in this release that falls into these categories then let me 
know - just a pointer to the commit and any extra comments that you would want 
to make would be helpful. In the mean time I will start the process of looking 
through the commits and will add things to the migration guide page, but bear 
in mind I don't always have all of the context for every change.

Thanks!
Paul

-- 
Paul Eggleton
Intel Open Source Technology Centre




^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: 3.0 release notes / migration guide
  2019-10-02 22:20 3.0 release notes / migration guide Paul Eggleton
@ 2019-10-02 22:44 ` akuster808
  2019-10-02 22:57   ` Paul Eggleton
  0 siblings, 1 reply; 4+ messages in thread
From: akuster808 @ 2019-10-02 22:44 UTC (permalink / raw)
  To: Paul Eggleton, openembedded-core, yocto


Paul,

On 10/2/19 3:20 PM, Paul Eggleton wrote:
> Hi folks
>
> So it's that time again - we need to start building up the raw material for 
> the release notes and migration guide for the upcoming 3.0 release, and I'd 
> like to request some help with some parts of it - read on for details.
>
> For the migration guide we have a wiki page serving as a staging area:
>
>   https://wiki.yoctoproject.org/wiki/FutureMigrationGuide

Thanks for putting this together.

>
> Things that should go in the migration guide: *anything* in the release that 
> would require someone who is upgrading to take some form of action (i.e. 
> change their configuration / recipes / etc.) Help with this from people who 
> implemented the changes or have already thought about / dealt with their 
> impact would be much appreciated.
>
> There is a process where I look through all the commits since the last release 
> and pull out the ones that need to be mentioned in some form - other than the 
> migration guide items, the following needs to be gathered for the release 
> notes:
>
> 1) Features - new functionality. We need to capture what the feature is and 
> hopefully express the impact to the user succinctly.
We remove LSB support.

> 2) Recipe upgrades - straightforward
>
> 3) CVE fixes - fairly straightforward, I just look for commits that explicitly 
> mention "CVE". If I can easily do so I'll also note where a recipe upgrade 
> fixes a CVE, but that isn't often readily available information.
So how can the community help in this case? Better commit messages?

>
> 4) Known issues - generally this is difficult to get from the commits since we 
> either find out about them after the commit that introduced the issue, or we 
> don't know that they aren't addressed until right at the end of the release. 
> We don't want to note *all* open bugs, but if there's something that the user 
> is likely to hit that wasn't an issue in the previous release then we should 
> note it.

Well, aren't open defects not fixed by the time we release time but we
intend on fixing after release a form of known issues ?

- armin


> For the release notes I need help with #4 and #1 in particular, so if you know 
> about anything in this release that falls into these categories then let me 
> know - just a pointer to the commit and any extra comments that you would want 
> to make would be helpful. In the mean time I will start the process of looking 
> through the commits and will add things to the migration guide page, but bear 
> in mind I don't always have all of the context for every change.
>
> Thanks!
> Paul
>




^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: 3.0 release notes / migration guide
  2019-10-02 22:44 ` akuster808
@ 2019-10-02 22:57   ` Paul Eggleton
  2019-10-02 23:32     ` akuster808
  0 siblings, 1 reply; 4+ messages in thread
From: Paul Eggleton @ 2019-10-02 22:57 UTC (permalink / raw)
  To: akuster808; +Cc: yocto, openembedded-core

On Thursday, 3 October 2019 11:44:53 AM NZDT akuster808 wrote:
> On 10/2/19 3:20 PM, Paul Eggleton wrote:
> > So it's that time again - we need to start building up the raw material for 
> > the release notes and migration guide for the upcoming 3.0 release, and I'd 
> > like to request some help with some parts of it - read on for details.
> >
> > For the migration guide we have a wiki page serving as a staging area:
> >
> >   https://wiki.yoctoproject.org/wiki/FutureMigrationGuide
> 
> Thanks for putting this together.

No problem!

> > Things that should go in the migration guide: *anything* in the release that 
> > would require someone who is upgrading to take some form of action (i.e. 
> > change their configuration / recipes / etc.) Help with this from people who 
> > implemented the changes or have already thought about / dealt with their 
> > impact would be much appreciated.
> >
> > There is a process where I look through all the commits since the last release 
> > and pull out the ones that need to be mentioned in some form - other than the 
> > migration guide items, the following needs to be gathered for the release 
> > notes:
> >
> > 1) Features - new functionality. We need to capture what the feature is and 
> > hopefully express the impact to the user succinctly.
>
> We remove LSB support.

Thanks - I've just added that to the migration guide and will note it in the release notes.

> > 2) Recipe upgrades - straightforward
> >
> > 3) CVE fixes - fairly straightforward, I just look for commits that explicitly 
> > mention "CVE". If I can easily do so I'll also note where a recipe upgrade 
> > fixes a CVE, but that isn't often readily available information.
>
> So how can the community help in this case? Better commit messages?

That would be great - but it does require the person doing the upgrade to look
upstream, and of course every upstream is different. Unfortunately with some
upstreams finding fixed CVE information is quite difficult indeed.

> Well, aren't open defects not fixed by the time we release time but we
> intend on fixing after release a form of known issues ?

Yes, that's true - I will say we haven't been particularly systematic about the
known issues in past releases so perhaps we should drive the list from
bugzilla. I would want the list to be kept as short as possible though and each
item should succinctly describe the issue. 

Cheers
Paul

-- 

Paul Eggleton
Intel Open Source Technology Centre




^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: 3.0 release notes / migration guide
  2019-10-02 22:57   ` Paul Eggleton
@ 2019-10-02 23:32     ` akuster808
  0 siblings, 0 replies; 4+ messages in thread
From: akuster808 @ 2019-10-02 23:32 UTC (permalink / raw)
  To: Paul Eggleton; +Cc: yocto, openembedded-core



On 10/2/19 3:57 PM, Paul Eggleton wrote:
> On Thursday, 3 October 2019 11:44:53 AM NZDT akuster808 wrote:
>> On 10/2/19 3:20 PM, Paul Eggleton wrote:
>>> So it's that time again - we need to start building up the raw material for 
>>> the release notes and migration guide for the upcoming 3.0 release, and I'd 
>>> like to request some help with some parts of it - read on for details.
>>>
>>> For the migration guide we have a wiki page serving as a staging area:
>>>
>>>   https://wiki.yoctoproject.org/wiki/FutureMigrationGuide
>> Thanks for putting this together.
> No problem!
>
>>> Things that should go in the migration guide: *anything* in the release that 
>>> would require someone who is upgrading to take some form of action (i.e. 
>>> change their configuration / recipes / etc.) Help with this from people who 
>>> implemented the changes or have already thought about / dealt with their 
>>> impact would be much appreciated.
>>>
>>> There is a process where I look through all the commits since the last release 
>>> and pull out the ones that need to be mentioned in some form - other than the 
>>> migration guide items, the following needs to be gathered for the release 
>>> notes:
>>>
>>> 1) Features - new functionality. We need to capture what the feature is and 
>>> hopefully express the impact to the user succinctly.
>> We remove LSB support.
> Thanks - I've just added that to the migration guide and will note it in the release notes.
>
>>> 2) Recipe upgrades - straightforward
>>>
>>> 3) CVE fixes - fairly straightforward, I just look for commits that explicitly 
>>> mention "CVE". If I can easily do so I'll also note where a recipe upgrade 
>>> fixes a CVE, but that isn't often readily available information.
>> So how can the community help in this case? Better commit messages?
> That would be great - but it does require the person doing the upgrade to look
> upstream, and of course every upstream is different. Unfortunately with some
> upstreams finding fixed CVE information is quite difficult indeed.
>
>> Well, aren't open defects not fixed by the time we release time but we
>> intend on fixing after release a form of known issues ?
> Yes, that's true - I will say we haven't been particularly systematic about the
> known issues in past releases so perhaps we should drive the list from
> bugzilla. I would want the list to be kept as short as possible though and each
> item should succinctly describe the issue. 

Maybe something the Yocto Bug triage team could possible assist in.   I
will bring it up tomorrow morning.

- armin

> Cheers
> Paul
>



^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2019-10-02 23:32 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2019-10-02 22:20 3.0 release notes / migration guide Paul Eggleton
2019-10-02 22:44 ` akuster808
2019-10-02 22:57   ` Paul Eggleton
2019-10-02 23:32     ` akuster808

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox