chore: rename CHANGELOG to CHANGELOG.md

Part-of: <https://dev.funkwhale.audio/funkwhale/funkwhale/-/merge_requests/2355>

changes/changelog.d/2067.misc

@@ -0,0 +1 @@
+Rename CHANGELOG to CHANGELOG.md

changes/template.md.j2

@@ -0,0 +1,28 @@
+## {{ versiondata.version }} ({{ versiondata.date }})
+
+Upgrade instructions are available at https://docs.funkwhale.audio/admin/upgrading.html
+
+{% for section, _ in sections.items() %}
+{% if sections[section] %}
+{% for category, val in definitions.items() if category in sections[section] %}
+{{ definitions[category]['name'] }}:
+
+{% if definitions[category]['showcontent'] %}
+{% for text in sections[section][category].keys() | sort() %}
+- {{ text }}
+{% endfor %}
+
+{% else %}
+
+- {{ sections[section][category][''] | join(', ') }}
+
+{% endif %}
+{% if sections[section][category] | length == 0 %}
+No significant changes.
+{% else %}
+{% endif %}
+{% endfor %}
+{% else %}
+No significant changes.
+{% endif %}
+{% endfor %}

changes/template.rst

@@ -1,33 +0,0 @@
-{{ versiondata.version }} ({{ versiondata.date }})
-{{ top_underline * ((versiondata.version + versiondata.date)|length + 3)}}
-
-Upgrade instructions are available at
-https://docs.funkwhale.audio/admin/upgrading.html
-
-{% for section, _ in sections.items() %}
-{% if sections[section] %}
-{% for category, val in definitions.items() if category in sections[section]%}
-{{ definitions[category]['name'] }}:
-
-{% if definitions[category]['showcontent'] %}
-{% for text in sections[section][category].keys()|sort() %}
-- {{ text }}
-{% endfor %}
-
-{% else %}
-- {{ sections[section][category]['']|join(', ') }}
-
-{% endif %}
-{% if sections[section][category]|length == 0 %}
-No significant changes.
-
-{% else %}
-{% endif %}
-
-{% endfor %}
-{% else %}
-No significant changes.
-
-
-{% endif %}
-{% endfor %}

docs/changelog.rst

@@ -1 +1 @@
-.. include:: ../CHANGELOG
+.. include:: ../CHANGELOG.md

docs/developer_documentation/workflows/release.md

@@ -52,7 +52,7 @@ Once we're ready to release a new version of the software, we can use the follow
    ```sh
    python3 scripts/get-contributions-stats.py $NEXT_RELEASE # Output a list of contributors
    git log $PREVIOUS_RELEASE.. --format="- %aN" --reverse | sort | uniq # Get a list of all commit authors
-   nano CHANGELOG # Add these lists to the CHANGELOG
+   nano CHANGELOG.md # Add these lists to the CHANGELOG.md
    ```
 
 7. Update the next release version

pyproject.toml

@@ -1,13 +1,13 @@
 [tool.towncrier]
 package = "changes"
 package_dir = ""
-filename = "CHANGELOG"
+filename = "CHANGELOG.md"
-directory = "changes/changelog.d/"
+directory = "changes/changelog.d"
-start_string = ".. towncrier\n"
+start_string = "<!-- towncrier -->\n"
-template = "changes/template.rst"
+template = "changes/template.md.j2"
 issue_format = ""
-title_format = "{version} (unreleased)"
+title_format = ""
-underlines = "-"
+underlines = [""]
 
 [[tool.towncrier.section]]
 path = ""