search

jimporter / mike

Manage multiple versions of your MkDocs-powered documentation via Git
BSD 3-Clause "New" or "Revised" License
534 stars 47 forks source link

Rename CHANGES.md to CHANGELOG.md #70

Closed Graham42 closed 2 years ago

Graham42 commented 3 years ago

This will enable auto-update tools like Renovate to detect the Changelog and include the details when the tool opens a PR. This improves the consumer developer experience.

jimporter commented 3 years ago

Thanks for the patch. However, reading their documentation, I don't think this is actually necessary:

If the source package includes a GitHub URL as its source, and has a "changelog" file or uses GitHub releases, a Release Note will be embedded in the generated PR

Since every update has a corresponding GitHub release, Renovate should be able to find the release notes. If that's not working, it seems like it'd be a bug in Renovate.

In any case, I don't think I'd want to call that file a "changelog", since a changelog is a somewhat different thing under GNU standards (i.e. a log of every change). CHANGES.md is more akin to NEWS (i.e. notable changes since the previous release). The "Keep a Changelog" site advocates differently, but I think their reuse of a preexisting term to mean something different was a mistake that adds unnecessary confusion. "CHANGES" doesn't have the same level of baggage, although perhaps something like RELEASE_NOTES.md would be even clearer.

jimporter commented 2 years ago

Closing per my previous comment.