scripts/generate-gh-release-notes: use github flavor markdown

bluetech · bluetech · commit 74e22f5bbeef · 2025-11-04T20:36:20.000+02:00
This fixes the `{.interpreted-text role="func"}` stuff that shows up with the `md` format which github doesn't support. See comparison gist: https://gist.github.com/bluetech/365f5b20f6ed1258439d65768714ddc0
diff --git a/scripts/generate-gh-release-notes.py b/scripts/generate-gh-release-notes.py
@@ -43,7 +43,7 @@ def extract_changelog_entries_for(version: str) -> str:
 
 def convert_rst_to_md(text: str) -> str:
     result = pypandoc.convert_text(
-        text, "md", format="rst", extra_args=["--wrap=preserve"]
+        text, "gfm", format="rst", extra_args=["--wrap=preserve"]
     )
     assert isinstance(result, str), repr(result)
     return result

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ def extract_changelog_entries_for(version: str) -> str:`
`43`	`43`
`44`	`44`	`def convert_rst_to_md(text: str) -> str:`
`45`	`45`	`result = pypandoc.convert_text(`
`46`		`- text, "md", format="rst", extra_args=["--wrap=preserve"]`
	`46`	`+ text, "gfm", format="rst", extra_args=["--wrap=preserve"]`
`47`	`47`	`)`
`48`	`48`	`assert isinstance(result, str), repr(result)`
`49`	`49`	`return result`