Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support rendering changelog as MarkDown files #139

Merged
merged 15 commits into from Feb 9, 2024

Conversation

felixfontein
Copy link
Collaborator

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
Copy link
Collaborator Author

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 felixfontein marked this pull request as ready for review February 4, 2024 19:27
@felixfontein felixfontein changed the title [WIP] Support rendering changelog as MarkDown files Support rendering changelog as MarkDown files Feb 4, 2024
@felixfontein
Copy link
Collaborator Author

This is ready for review!

@felixfontein
Copy link
Collaborator Author

@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).

@felixfontein felixfontein merged commit b1a9862 into ansible-community:main Feb 9, 2024
3 checks passed
@felixfontein felixfontein deleted the markdown branch February 9, 2024 12:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant