Re: [libvirt] [PATCH v2 1/3] NEWS: Improve building pipeline
On Thu, 2017-01-05 at 14:45 +0000, Daniel P. Berrange wrote:
> docs/news.xml | 241
++++++++++++++++++++++++++++++++++++++++++++++++++++
Instead of a single ever growing file, lets do one file per
release. eg
docs/news/v2.0.0.xml
docs/news/v2.1.0.xml
...
docs/news/v3.0.0.xml
...
and have a docs/news/template.xml as a source people can copy
to create the initial file for a release.
This also gives us flexibilty when generating the output,
meaning we can make the XSLT automatically pull in just
the 10 most recent releases to NEWS, avoiding the need
to periodically trim/rename files to archive old news.
Most projects I'm familiar with never trim the contents of
the NEWS file, which makes sense because with a proper
release notes process in place (one entry per user-visible
change) the amount of information added per release is
fairly low.
It was needed back when the release notes were basically
just the output of `git log --pretty=oneline` because that
was way too much information to wade through; and even
then, we're still shipping a full ChangeLog that's
guaranteed to be way, way bigger than the release notes
could ever be.
$ du -sk docs/news.xml NEWS ChangeLog
8 docs/news.xml
8 NEWS
8660 ChangeLog
--
Andrea Bolognani / Red Hat / Virtualization