I agree with Vadim - it's better to make release notes manually, maybe
consisting of few sections (New features, Important Bug Fixes, Deprecation,
...)
On Mon, Sep 25, 2017 at 4:01 PM, Vadim Zeitlin <vz-s...@zeitlins.org> wrote:
> On Sat, 23 Sep 2017 23:43:03 +0200 Mateusz Loskot <mate...@loskot.net>
> wrote:
>
> ML> On 23 September 2017 at 23:31, Mateusz Loskot <mate...@loskot.net>
> wrote:
> ML> >
> ML> > I'm experimenting with auto-generated change log.
> ML> >
> ML> > https://github.com/SOCI/soci/blob/master/CHANGELOG.md
>
> This looks too verbose/long to be useful to me. I understand the appeal of
> automatic changelog generation from the developer/maintainer point of view,
> but I don't really see the point of having changelog from the user point of
> view if it basically boils down to "git log --oneline last_release.." or
> similar. The purpose of changelog should, IMO, be to highlight important
> changes and not list all of them, so it needs to be either maintained
> manually or have entries extracted only from git commits marked with some
> "[change]" tag -- but in the latter case I question the benefit of using
> this tag compared to just updating the changelog directly, so we're back to
> maintaining it manually.
>
> ML> Alternatively, CHANGES file is converted to release notes maintained
> ML> manually and included in the documentation:
> ML>
> ML> For example, http://www.mkdocs.org/about/release-notes/
>
> This (or current SOCI changelog, for that matter) looks more useful to me.
>
> Regards,
> VZ
>
> ------------------------------------------------------------
> ------------------
> Check out the vibrant tech community on one of the world's most
> engaging tech sites, Slashdot.org! http://sdm.link/slashdot
> _______________________________________________
> soci-devel mailing list
> soci-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/soci-devel
>
>
--
With best wishes, Alex Ott
http://alexott.net/
Twitter: alexott_en (English), alexott (Russian)
Skype: alex.ott
------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
_______________________________________________
soci-devel mailing list
soci-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/soci-devel
