DFHack / dfhack

Memory hacking library for Dwarf Fortress and a set of tools that use it
Other
1.86k stars 471 forks source link

generate BBcode changelogs #3268

Open myk002 opened 1 year ago

myk002 commented 1 year ago

Reddit now accepts markdown, so we don't need the "reddit" changelog output but Steam requires BBcode, so it might be a good idea to output changelogs in that format so we can post Steam announcements easier.

pandoc with the https://github.com/lilydjwg/2bbcode plugin could do it

lethosor commented 1 year ago

+1 for pandoc, although I would make it an optional dependency (which I suppose is generally the case for our docs dependencies anyway).

Reddit has always supported markdown, at least since we started posting releases there - the only special thing about the "reddit" output is that it puts everything in a blockquote, which I was using when I posted releases there. It can certainly be changed if you prefer a different format now.

myk002 commented 1 year ago

I'm having slight second thoughts about this. The entire first half of the release notes are still hand-written in markdown, so even if we implement changelogs in BBCode, we'd still have to do the same conversion process for the manually written part. The changelog doesn't add any additional work to the manual process (it's still one button click for search and replace), so there may be no benefit to automating that part of the conversion.

lethosor commented 1 year ago

I'm sure we could run the blurbs through pandoc as well. Although at that point, running the entirety of the Github changelog through pandoc might be easier in terms of dev effort.

I've considered adding support for blurbs to the changelog generator, but it likely wouldn't support things like images...