seems the bot is wrong on this? alt="'This blob took too long to generate.' error".

guessing this is because when pasting an image in it uses HTML format instead of markdown and the bot is only checking for markdown issues. 🤔

replace changelog with github releases

You mean like these releases that we've been publishing since our very first release...?

https://github.com/typescript-eslint/typescript-eslint/releases

The changelog files we don't manually cleanup/curate (unlike the GH releases) - they're mostly a vestige of the release tooling we've been too lazy to turn off.

because that file still exists tools like npm-upgrade lead users to a file that can't be seen on github. is there any reason to keep it around?

tools like npm-upgrade lead users to a file that can't be seen on github

I mean -- that seems like a bug in the tool that it would lead you to that instead of our actual release notes. It looks like they just naively check for the changelog files before checking the releases list.

They also have a manually curated list of URLs that could be updated for our repo if they so desired.

is there any reason to keep it around?

Some people honestly prefer that file because it's an unfiltered, unpaginated list of changes for each release -- so it's easy to search and scroll everything.

But also the tool has 4550 weekly downloads -- that's like 0.01% of our userbase that would be impacted by the tool misbehaving..

so it's easy to search and scroll everything.

not if it doesn't render in github.

But also the tool has 4550 weekly downloads

that's 1 tool. a lot of other similar tools do similar things.

the core issue isnt even the tool usage it's the fact the file is no longer viewable on github. which would effect a lot more of the user base..

I agree with Brad on this one. The CHANGELOG.md is not our canonical location for listing changes. https://github.com/typescript-eslint/typescript-eslint/releases always has been.

Both the changelog file and releases page are queryable by tools. It's pretty straightforward to, given a repo locator like typescript-eslint/typescript-eslint, determine whether it uses GitHub releases or not.

If a downstream tool ignores the releases page in favor of the changelog, I'd consider that a bug on the downstream tool. GitHub releases are a much more structured format than raw Changelog markdown. I would think tools should generally prefer it.

a lot of other similar tools do similar things.

My advice would be to, for any tool you use that points to the changelog file instead of releases, file a bug on them. 🙂

fair enough.