A while back we had discussed adopting ParaView’s practice of adding a markdown changelog to each significant merge request (MR).
- I’m starting that with SMTK MR 1096, which adds a note to the (new)
- There is an example in
doc/release/notesthat you can use as a template.
- Whoever performs a release of SMTK should erase all the files in
doc/release/notes, organizing their content into a file named
doc/release/announcement.md. Any previous content in
doc/release/announcement.mdshould be discarded at each major revision; the git history may be used to examine it if necessary.
- ParaView’s repo adds a reminder to the “Do: check” results if it doesn’t find an addition to the release note directory inside a MR… can we enable that for SMTK or do we need to wait for Ben to return?