changelog files should be rendered as Markdown on Hackage

[ulysses4ever]

Otherwise, they look obnoxious.

Allegedly, you only need to rename changelog -> changelog.md

[Kleidukos]

Tangent, but what was the original reason for not uploading the changelog of cabal-install itself and instead refer to a link on GitHub?

[ulysses4ever]

Right… @Mikolaj would know better but if I was to guess, I'd say that otherwise it would be a pretty damn big file, which everyone would download only to read a bit at the top. It's not the extra bytes traveling over the network that are annoying but the sloppiness of the rendering engine: web browsers are not very good at rendering such cases. Unless you're using eww, of course.

[Mikolaj]

Artem may be right and this may be a good reason to keep it that way. But even oldest women don't know the original reasons. My guess was that thanks to that indirection and to pointing to the master branch, you can easily fix the changelog after the package is on Hackage, which is then immutable.

Edit: We already heavily used that feature for 3.8.1.0.

Edit2: In principle, we could use it now, as well, to copy a portion of the discussion from the release announcement there or at least point to the announcement (which would make more sense if there was lots of user chatter there).

[ulysses4ever]

I'm sorry, I just screwed up: I tried the VS Code in the browser thing ("codespace"?), renamed the file, and pushed some green button. That silly thing pushed right into master: no branch, no PR. It's crazy...

[ulysses4ever]

Of course, CI fails on it... Whitespace, specifically.

[ulysses4ever]

I reverted it in the same devilish style: by pushing right into master. Sorry, but this looked the most reasonable.

[Mikolaj]

No sweat. :)