Releases: Adjust markdown format #306
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When services like https://github.com/renovatebot/renovate open dependency update pull requests they try to find a corresponding changelog entry to let the developers know what changes this dependency update includes. The current format of the `RELEASES.md` file with its nested lists appears to be uncommon enough to not get recognized by at least renovatebot. This changes the format to use `h2` elements for the versions, which should allow renovatebot to pick up the contents and generally renders in a slightly nicer way :D
|
Sounds good, thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When services like https://github.com/renovatebot/renovate open dependency update pull requests they try to find a corresponding changelog entry to let the developers know what changes this dependency update includes.
The current format of the
RELEASES.mdfile with its nested lists appears to be uncommon enough to not get recognized by at least renovatebot.This changes the format to use
h2elements for the versions, which should allow renovatebot to pick up the contents and generally renders in a slightly nicer way :DBest reviewed in "ignore whitespace" mode: https://github.com/indexmap-rs/indexmap/pull/306/files?w=1 😉
/cc @cuviper