Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support links in Changelog #36

Open
amcclain opened this issue Sep 27, 2021 · 0 comments
Open

Support links in Changelog #36

amcclain opened this issue Sep 27, 2021 · 0 comments
Assignees

Comments

@amcclain
Copy link
Member

It would be very helpful to support links to changelog entries, especially since the syntax and formatting supported by the log itself is so minimal. This could allow entries to link off to issue tracking systems, wikis, etc. for more detailed explanations and feature guides.

Note that what we can do here will be largely determined by what the changelog-parser lib supports. This option looks relevant, although would need to look closely at the output to see how links are processed, as well as any other markdown syntax that might be used:

https://github.com/hypermodules/changelog-parser#removemarkdown

See here for where we parse the changelog by calling this library:

// Parse CHANGELOG.md and write to tmp .json file, if requested. Write fallback file if disabled

Note that it might be helpful to call the library directly to see / iterate on the output with different options, instead of restarting an app every time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants