Skip to content
This repository has been archived by the owner on May 23, 2024. It is now read-only.

Support a small template system for changelog version descriptions #144

Open
erunion opened this issue Jan 26, 2018 · 0 comments
Open

Support a small template system for changelog version descriptions #144

erunion opened this issue Jan 26, 2018 · 0 comments

Comments

@erunion
Copy link
Owner

erunion commented Jan 26, 2018

Can we make the field names in the description yellow like the body (eg in "Deprecated metadata.connections.activities in the User representation" metadata.connections.activities should be yellow)

We should add in a small template system for Mill changelog version descriptions so we can wrap key pieces of data in declarations that can then be converted into styleable HTML elements.

The format of the template should be something like {parameter}parent_folder{/parameter} or {representation}Video{/representation}. Follow the current set of supported elements we have in Mill changelogs: https://github.com/vimeo/mill/wiki/Generating-Changelogs#json

When converted into HTML within the JSON formatter, these should be wrapped in span tags akin to how it already works in changelog changesets:

<span class="mill-changelog_param" data-mill-parameter="parent_folder">parent_folder</span>
<span class="mill-changelog_representation" data-mill-parameter="representation">Video</span>

And in the Markdown formatter, they should just be wrapped in backticks like everything else.

@erunion erunion modified the milestone: v3.0 Jan 26, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant