make-release-notes icon indicating copy to clipboard operation
make-release-notes copied to clipboard

Published 20 hours ago • verified publisher icon scala

Generated Markdown files should have comment that describes which script generated it

Open gkossakowski opened this issue 11 years ago • 2 comments

Given the fact that we generate those files in this project and then use it somewhere else (e.g. in scala-lang) it would be good to include a comment in generated Markdown file that points back at script that generated it.

It would vastly help to understand where given files are coming from when analyzing history of previous releases.

gkossakowski avatar Sep 27 '13 20:09 gkossakowski

ironically, markdown breaks on comments: https://github.com/scala/scala-lang/pull/158

adriaanm avatar Jan 28 '14 21:01 adriaanm

This would be of great help. I got tripped up by this on scala/scala-lang#497.

jarrodu avatar Oct 30 '16 17:10 jarrodu