search

rhysd / changelog-from-release

Simple changelog generator from GitHub releases
https://github.com/rhysd/changelog-from-release/blob/master/CHANGELOG.md
MIT License
83 stars 14 forks source link

Add a text-only option #29

Open ricardoboss opened 3 months ago

ricardoboss commented 3 months ago

Hi! We've recently started using the action to generate release notes from GitHub Releases in https://github.com/std-uritemplate/std-uritemplate.

I seems to be working fine, but some packages we publish don't support rendering Markdown/HTML in the CHANGELOG (see https://github.com/std-uritemplate/std-uritemplate/issues/219).

Would it be possible to add a mode that only generates text, without links, comments or any structural elements at all?

rhysd commented 4 weeks ago

I considered this feature but I don't think it is needed for this tool. You can convert the generated Markdown file into a plain text. I would recommend using Pandoc.

pandoc CHANGELOG.md -t plain -o CHANGELOG.txt --wrap=none
rhysd commented 4 weeks ago

CHANGELOG.txt

Here is an example of the plain text converted from CHANGELOG.md. Conversion looks working nicely to me.