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

Releases: Adjust markdown format #306

Merged
merged 1 commit into from
Feb 1, 2024
Merged

Conversation

Turbo87
Copy link
Contributor

@Turbo87 Turbo87 commented Feb 1, 2024

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

Best reviewed in "ignore whitespace" mode: https://github.com/indexmap-rs/indexmap/pull/306/files?w=1 😉

/cc @cuviper

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
@cuviper
Copy link
Member

cuviper commented Feb 1, 2024

Sounds good, thanks!

@cuviper cuviper added this pull request to the merge queue Feb 1, 2024
Merged via the queue into indexmap-rs:master with commit 2044a2e Feb 1, 2024
15 checks passed
@Turbo87 Turbo87 deleted the patch-1 branch February 2, 2024 09:19
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

Successfully merging this pull request may close these issues.

2 participants