Losing points due to too large changelog

[spydon]

In Flame we have an exceptionally good changelog, I think it sends the wrong signals from Pub to get minus points for this.
(Although we are very happy that we can now publish without modifications after the size limit was bumped to 256KB! 🥳)

If there is a technical issue by pub not being able to handle the file size, I think there should be a proper solution for this and something that should be solved on Pub's side, not on the package author's side.

Related: dart-lang/pub-dev#6012

Any new users searching for how to keep a good changelog will get results like these in the top:
https://keepachangelog.com/
https://docs.gitlab.com/ee/development/changelog.html
https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md
https://www.freecodecamp.org/news/a-beginners-guide-to-git-what-is-a-changelog-and-how-to-generate-it/
None which recommend splitting up the changelog into multiple files. Keeping all changes in CHANGELOG.md has been the de facto open source standard for quite a while.

For search engines:
Provide a valid CHANGELOG.md
CHANGELOG.md too large

[renancaraujo]

if the biggest technical problem with large change logs is page load, the site could truncate the content up until a certain size.

[rydmike]

Ok this is just silly, now you loose pub points for being thorough and documenting things well with a good detailed changelog!?

This sends the wrong signal to devs. Encouraging logs like "We fixed a number of bugs". Logs that are not very useful, but will keep it short to stay below the 128kB limit for getting the desired "valid" changelog points.

[spydon]

Maybe the issue with points being deducted is accidental and that this line just wasn't updated together with dart-lang/pub-dev#7065:
https://github.com/dart-lang/pana/blob/master/lib/src/report/template.dart#L26

[rydmike]

@spydon looks likely, since it would be really easy to forget that line and check when PR dart-lang/pub-dev#7065 was done. This limit default does not depend on any of the constants used for the upload sizes, it is just a hard coded number default. If call site then just uses the defaults, then bam, what we got now would be the result.

[sigurdm]

Yeah, this is just an accidental oversight - @isoos we should also fix this in pana!

[isoos]

Ah, good point, sorry for the confusion it made! Transferring the issue to pana.

[sigurdm]

Maybe we can remove the check from pana entirely, since we have the size limit at upload time

[spydon]

Thanks for fixing this so incredibly quickly! 💙

[isoos]

@spydon: this is only merged now, it may take a while until this gets released on pub.dev

[spydon]

@spydon: this is only merged now, it may take a while until this gets released on pub.dev

No worries, at least now we know that the fix will be there at some point.