jamulus icon indicating copy to clipboard operation
jamulus copied to clipboard

Rename ChangeLog to ChangeLog.md to enable Markdown format (and change release scripts)

Open ann0see opened this issue 2 years ago • 1 comments

What is the current behaviour and why should it be changed? Curently the ChangeLog doesn't support styling but includes markdown format since the content gets copied to the release notes. It would be good to rename the file to ChangeLog.md to allow formatting. This implies a change in multiple files and probably different styling.

Describe possible approaches Change the Headlines to ## <Version> (use grep) Verify that the changelog getter scripts understand the new format Test the new workflow Rename ChangeLog to ChangeLog.md

Has this feature been discussed and generally agreed? No. Maybe not much benefit?

ann0see avatar Mar 15 '22 22:03 ann0see

One thing to consider is that ChangeLog or CHANGELOG is a pseudo-standard name and people or tools might look for exactly that name. The Changelog is also parsed as part of our Debian package build process.

hoffie avatar Mar 15 '22 22:03 hoffie

Fixed as I added a Vim comment at the end of the file a while ago. GitHub now handles it correctly.

ann0see avatar Feb 25 '23 18:02 ann0see

Fixed as I added a Vim comment at the end of the file a while ago. GitHub now handles it correctly.

Prior to r3_9_1rc1, so dropping from 3.10.0.

pljones avatar Jul 29 '23 12:07 pljones