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

Markdown processing #47

Open
matthiasbeyer opened this issue Sep 5, 2022 · 1 comment
Open

Markdown processing #47

matthiasbeyer opened this issue Sep 5, 2022 · 1 comment

Comments

@matthiasbeyer
Copy link
Owner

The user should be able to use markdown markup in the changelog fragments and it should automatically be adapted for the final changelog file.

For example: They enter the following text for a fragment:

# Change API type: SessionToken

The SessionToken is now a `uuid` rather than a `u64`.

That would render (with the default template right now) to:

# CHANGELOG

## v0.1.0

# Change API type: SessionToken

The SessionToken is now a `uuid` rather than a `u64`.

But the Change API type: SessionToken heading should clearly be a ### heading.
This kind of processing should be done by cargo-changelog (IMO via a template helper).

@matthiasbeyer
Copy link
Owner Author

I guess it would be a better solution to provide generic text-modifying helpers for the template, rather than assuming markdown formatting.

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

1 participant