[vtk-developers] Thoughts on changelog maintenance?

[Elvis Stansvik]

2017-11-07 20:40 GMT+01:00 Brad King <brad.king at kitware.com>:
> On 11/07/2017 02:10 PM, Ben Boeckel wrote:
>>   - a directory of files, one per changelog entry.
>> ...
>> How about putting them in `Documentation/release/dev`?
>
> To clarify, changelog entries during development would be put in
> files in that directory.  Then at release time they will be
> consolidated into a single file for that release.  Then the
> directory would be used to collect changelog entries for the
> next release.  CMake does this for its release notes.
>
> So:
>
> - `Documentation/release/dev/$topic.md` files have changelog
>   entries for new development since the last release.
>
> - `Documentation/release/$version.md` has consolidated changelog
>   entries for release $version when released.
>
> The latter could be put in other places, like a top-level
> `CHANGELOG.md` file, since it is consolidated and curated by hand.

Ah, makes sense. Thanks for clarifying.

Elvis

>
> -Brad
> _______________________________________________
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at http://www.kitware.com/opensource/opensource.html
>
> Search the list archives at: http://markmail.org/search/?q=vtk-developers
>
> Follow this link to subscribe/unsubscribe:
> http://public.kitware.com/mailman/listinfo/vtk-developers
>