[Gluster-devel] [Gluster-Maintainers] Release 4.1: LTM release targeted for end of May

[Shyam Ranganathan]

On 03/14/2018 02:40 AM, Aravinda wrote:
> I have following suggestion for managing release notes. Let me know
> if this can be included in automation document.

Aravinda, I assume this is an additional suggestion, orthogonal to the
current discussion around spec and docs, right?

> 
> 
> If a Github issue used in Commit message as "Fixes: #<id>" then Smoke
> test should fail if patch does not contain `$SRC/release-notes/<issue>.md`
> (if `$SRC/release-notes/<issue>.md` not already exists in codebase)
> 
> On branching, delete all these release-notes from Master branch and start
> fresh. Release branch now contains these notes for all the features
> went in after the last release. Release manager's job is to merge all
> these release notes into single release notes document.
> 
> We can restrict on the format of release-note as,
> 
>     First Line is Title
>     Tags: component-name, keywords etc
>     --
>     Description about the feature, example, links etc
> 
> If all patches are submitted with `Updates` instead of `Fixes`, then
> Issue can't be closed without submitting patch with release-note.

Most of the above is fine and we can thrash out specifics, but...

I am thinking differently, if spec and doc are provided writing a short
1-5 line summary in the release notes is not a problem.

The issue at present is that, to get contents into the release notes, at
times even the code has to be read to understand options, defaults and
what not. This being done by one person has been a challenge.

So if we address spec and doc, I/we can check how easy it is to write
release notes from these (over the next couple of releases say) and then
decide if we want authors to provide the release notes as well.

Thoughts?

Shyam