Re: Adding NEWS entries to each active stable release branch (was: NEWS handling)
| From: | Johannes Schlüter | Date: | Wed, 16 Oct 2013 16:15:10 +0000 |
| Subject: | Re: Adding NEWS entries to each active stable release branch (was: NEWS handling) | ||
| References: | 1 2 3 4 | Groups: | php.internals |
| Request: | Send a blank email to internals+get-69587@lists.php.net to get a copy of this message | ||
On Wed, 2013-10-16 at 18:02 +0200, Pierre Joye wrote:
> On Wed, Oct 16, 2013 at 3:23 PM, Johannes Schlüter
> <johannes@schlueters.de> wrote:
>
> > Ideal would be a tool where an RM can invoke a script which parses
> > commit messages and builds NEWS from there. This requires some stricter
> > rules on commit message formats, though. (the idea is as old as the git
> > migration but there wasn't a good idea, yet)
>
> Yes, that's the idea behind the new commit message format:
>
> https://wiki.php.net/vcs/gitworkflow#new_commit_message_format
>
> But somehow even harder to enforce.
That format is not enough for that purpose. It is i.e. missing a
specification for the NEWS categories ("Core" or extension name etc.) I
believe if we have a good(!) format for that RMs can hit developers not
following it so they remember.
Requirement from top of my head for a good format:
- Easy to remember and type (developers are lazy, the more complicated
the harder it is to get "proper" pull requests etc.)
- Easy to parse
- Provides category
- provides a way to mark null-merges (i.e. 5.4-only fix merged up)
- additional authors (primary author should be in commit itself)
Anybody is welcome to pickup this challenge and define a format and
writing a NEWS-file generator based on it (... and html changelog
generator and release announcement generator and ...) :)
johannes