search

ansible-community / antsibull-changelog

Changelog generator for ansible, ansible-base, and collections.
https://ansible.readthedocs.io/projects/antsibull-changelog/
GNU General Public License v3.0
36 stars 28 forks source link

Support rendering changelog as MarkDown files #139

Closed felixfontein closed 7 months ago

felixfontein commented 7 months ago

This is a project to render changelogs as MarkDown files next to ReStructuredText files (the current default).

This is necessary since GitHub screwed up their RST preview, which results in many collection changelogs to no longer render. This also affects the main Ansible changelogs.

Ref: https://github.com/orgs/community/discussions/86715

felixfontein commented 7 months ago

The latest commits allow to write the changelog in multiple formats (RST and MD are supported right now). The MD result looks like this: https://github.com/felixfontein/antsibull-changelog/blob/markdown/CHANGELOG.md (compare this to https://github.com/felixfontein/antsibull-changelog/blob/markdown/CHANGELOG.rst).

felixfontein commented 7 months ago

This is ready for review!

felixfontein commented 7 months ago

@oraNod @gotmax23 I plan to merge this tomorrow and create a new antsibull-changelog release to get this out (and convert the primary changelog of various collections I maintain to MD).