changelog markdown modernization

[idiomatic]

• [x] rename CHANGELOG.txt to CHANGELOG.md [@JanGalek in #35]
• [ ] choose markdown subset to maximize compatibility with CurseForge and GitHub
• [x] survey other popular addons and decide if the convention is to attach the entire changelog, or just the most recent section
• [x] if the latter convention, integrate a minimal changelog section splitter into the publish workflow [@idiomatic]

[idiomatic]

https://authors.curseforge.com/knowledge-base/projects/103-files-types-definitions-and-management suggests:

Changelog: A place to put all the updates you have done between versions

[idiomatic]

considering extracting spans via:

VERSION=0.5.0 CHANGELOG=CHANGELOG.md
sed -n "/^##* *\[*v${VERSION}/,/^##* *\[*v/{/v/\!p;}" < $CHANGELOG

or:

VERSION=0.5.0 CHANGELOG=CHANGELOG.md
sed -n "/^##* *\[*v${VERSION}/,/v/p" < $CHANGELOG | sed -e '$d'

[idiomatic]

CurseForge's markdown translator looks bad.

[JanGalek]

Do you know where can found some documentation for theirs markdown ?

[JanGalek]

Do you mean bullets missing ? I see one difference (we now use - and before *). It absolute ignore - so I try add it after.

[JanGalek]

I tried it in description ( https://www.curseforge.com/wow/addons/maps) and it looks good, where do you see it ?

I found something on forum - https://authors.curseforge.com/forums/wow-sites/wow-sites-feedback/231426-markdown-broken-in-changelog :/

[idiomatic]

Do you know where some documentation [can be found] for theirs markdown?

No.

Do you mean bullets missing?

To be honest, I did not notice the lack of bullets. The initial issue I had with their markdown rendering was the spacing between lines. At best, I would describe it as "mechanical", but it is so typographically bland that @stevejobs would be turning in his grave.

I tried it in description (https://www.curseforge.com/wow/addons/maps) and it looks good, where do you see it?

Until we see evidence otherwise, I think we should lower expectations of what is to be possible from CurseForge. Maybe we just find a bullet solution then call it a day.

[idiomatic]

Warning: Nitpicking follows.

Do the [ and ] around ### headings content intend to do something akin to <a name="{text}">{text}</a>? Neither GitHub Markdown nor CurseForge Markdown translates it. I think GitHub Markdown uses the ### as a clue to add name="{text}" positional marking. With either renderer, the [ and ] are minor "visual noise".

We'll keep it as-is (with the brackets) if you like the style.

[JanGalek]

Not found - ou I have it as experimental so don't see anyone else.

yeah, we can keep it. Maybe we can add date to version but it's just sugar :)