Convert changelog to Markdown (MyST)

.github/workflows/lsp-release.yml

@@ -25,13 +25,9 @@ jobs:
         python-version: "3.10"
 
     - run: |
-
-        sudo apt update
-        sudo apt install pandoc
-
         python --version
         python -m pip install --upgrade pip
-        python -m pip install --upgrade tox bump2version towncrier docutils
+        python -m pip install --upgrade tox hatch towncrier docutils
       name: Setup Environment
 
     - run: |

.github/workflows/vscode-release.yml

@@ -34,9 +34,6 @@ jobs:
           ${{ runner.os }}-vscode-pip-deps
 
     - run: |
-        sudo apt update
-        sudo apt install pandoc
-
         python --version
         python -m pip install --upgrade pip
         python -m pip install --upgrade tox hatch towncrier docutils

docs/changelog.md

@@ -0,0 +1,5 @@
+# Changelog
+
+```{include} ../lib/esbonio/CHANGES.md
+:relative-images:
+```

docs/conf.py

@@ -54,6 +54,7 @@
     "esbonio.tutorial",
     "cli_help",
     "collection_items",
+    "myst_parser",
 ]
 
 autodoc_member_order = "groupwise"

docs/requirements.txt

@@ -3,6 +3,7 @@
 sphinx
 sphinx-design
 furo
+myst-parser
 pytest_lsp
 -e lib/esbonio
 -e lib/esbonio-extensions[tutorial]

lib/esbonio/pyproject.toml

@@ -67,11 +67,11 @@ explicit_package_bases = true
 check_untyped_defs = true
 
 [tool.towncrier]
-filename = "CHANGES.rst"
+filename = "CHANGES.md"
 directory = "changes/"
-title_format = "v{version} - {project_date}"
-issue_format = "`#{issue} <https://github.com/swyddfa/esbonio/issues/{issue}>`_"
-underlines = ["-", "^", "\""]
+title_format = "## v{version} - {project_date}"
+issue_format = "[#{issue}](https://github.com/swyddfa/esbonio/issues/{issue})"
+underlines = ["", "", ""]
 
 type = [
     { name = "Breaking Changes", directory = "breaking", showcontent = true },

scripts/make_release.py

@@ -14,7 +14,6 @@
 import re
 import subprocess
 import sys
-import tempfile
 from datetime import datetime
 from typing import Dict
 from typing import Optional
@@ -188,7 +187,7 @@ def generate_changelog(component: Component, version: str):
     """Generate the changelog for the release."""
 
     changes = pathlib.Path(component["src"]) / "changes"
-    if IS_RELEASE and len(list(changes.glob("*.rst"))) == 0:
+    if IS_RELEASE and len(list(changes.glob("*.md"))) == 0:
         print("No changes detected, aborting")
         sys.exit(1)
 
@@ -201,7 +200,7 @@ def generate_changelog(component: Component, version: str):
         print("Unable to get changelog!")
         sys.exit(1)
 
-    draft_file = pathlib.Path(tempfile.gettempdir()) / "changelog.rst"
+    draft_file = pathlib.Path(component["src"]) / ".changes.html"
     draft_file.write_text(draft)
 
     with Output(STEP_SUMMARY) as summary:
@@ -210,22 +209,13 @@ def generate_changelog(component: Component, version: str):
     if not IS_RELEASE:
         return
 
-    # Release notes for github
-    run(
-        "rst2html.py",
-        "--template=changes/github-template.html",
-        str(draft_file),
-        ".changes.html",
-        cwd=component["src"],
-    )
-
-    # Release notes for changelog.
+    # Release notes for changelog
     run("towncrier", "build", "--yes", f"--version={version}", cwd=component["src"])
 
     # Needed for VSCode marketplace
     if component["name"] == "vscode":
         run(
-            *["pandoc", "CHANGES.rst", "-f", "rst", "-t", "gfm", "-o", "CHANGELOG.md"],
+            *["cp", "CHANGES.md", "CHANGELOG.md"],
             cwd=component["src"],
         )