Write changelog in markdown using MyST #941
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,26 +5,29 @@ categories: | |
| label: 'feature' | ||
| - title: 'Enhancements' | ||
| label: 'enhancement' | ||
| - title: 'Deprecations' | ||
| label: 'deprecation' | ||
| - title: 'Bug Fixes' | ||
| label: 'bug' | ||
| - title: 'Documentation' | ||
| label: 'documentation' | ||
| - title: 'Maintenance' | ||
| label: 'maintenance' | ||
| exclude-labels: | ||
| - 'skip-changelog' | ||
| category-template: '### $TITLE' | ||
|
There was a problem hiding this comment. Need help to find a way to make the subheaders (e.g. for v0.2.1 enhancements) a proper permalink. I.e. something like https://pygmt-git-myst-changelog.gmt.vercel.app/changes.html#v0-2-1-enhancements instead of https://pygmt-git-myst-changelog.gmt.vercel.app/changes.html#id3 There was a problem hiding this comment. It seems commonmark still doesn't support anchors for headers, so maybe we can do nothing here. There was a problem hiding this comment. Maybe do it in sphinx instead? I see https://stackoverflow.com/questions/15394347/adding-a-cross-reference-to-a-subheading-or-anchor-in-another-page#comment79146992_40225340 pointing to https://www.sphinx-doc.org/en/master/usage/extensions/autosectionlabel.html#confval-autosectionlabel_prefix_document. There was a problem hiding this comment.
I don't think it works for us. There was a problem hiding this comment. @weiji14 As we have no solution for the custom anchors, do you think we should not use h3 headers, but just use bold headings, i.e., use There was a problem hiding this comment. Would stick with h3 headers. Even without the permalink anchors, it'll still be easier for users to navigate quickly to the subsection on the sidebar:
And people could still point to the v0.3.0 highlights using https://www.pygmt.org/v0.3.0/changes.html#highlights, and so on for v0.4.0 and beyond. |
||
| change-template: '* $TITLE ([#$NUMBER]($URL))' | ||
| template: | | ||
| ## Release v$NEXT_PATCH_VERSION (20YY/MM/DD) | ||
|
|
||
| [](https://doi.org/10.5281/zenodo.3781524) | ||
weiji14 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### Highlights | ||
|
|
||
| * | ||
|
|
||
| $CHANGES | ||
|
|
||
| ### Contributors | ||
|
|
||
| $CONTRIBUTORS | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Categories have been reordered following #885 (comment). Do we want to reorder things in the previous release changelogs (i.e. v0.1.0 to v0.3.0) or just keep them as they were?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me.
No need to reorder the old entries.