Pub: Feature request: warn if version to be published is absent from changelog

Created on 24 Nov 2018  路  9Comments  路  Source: dart-lang/pub

I have a devil of a time remembering to update my changelog prior to publishing a new version of a package, and I know the publish command is capable of kicking out warnings prior to publication if it finds anything that looks fishy. I'd love it if pub automatically scanned the changelog.md file in my package for the version number I'm trying to publish, and warned me if it wasn't present.

Most helpful comment

Huh, I just accidentally published a package yesterday which had no changelog at all which this check appears to allow https://github.com/dart-lang/pub/blob/master/lib/src/validator/changelog.dart#L23.

I would consider making that a warning as well as all packages should have a changelog.

All 9 comments

That seems pretty reasonable to me, fwiw @RedBrogdon this would be fairly easy to add yourself if you wanted to make a contribution :).

Once Flutter Live is over (post Dec. 4th, essentially), I should have time to work on it. I might need some hand-holding at first -- I have no idea how to run pub from source, for example. It seems like a good way to get to know the code a bit, though.

Ok sure, also not a requirement just mentioning that is an option (and probably a faster one than waiting for somebody else to come fix this)

cc @jonasfj @sigurdm how you do both feel about this? Willing to accept a contribution for it?

I believe we already have this: https://github.com/dart-lang/pub/blob/master/lib/src/validator/changelog.dart#L46

Please reopen if something else was meant.

I think this is my fault for leaving the bug open. I was still new to working with the Dart team back then and probably didn't feel confident claiming I'd actually fixed something. 馃槃

Huh, I just accidentally published a package yesterday which had no changelog at all which this check appears to allow https://github.com/dart-lang/pub/blob/master/lib/src/validator/changelog.dart#L23.

I would consider making that a warning as well as all packages should have a changelog.

I agree we should warn about that. Opened https://github.com/dart-lang/pub/issues/2337

Was this page helpful?
0 / 5 - 0 ratings

Related issues

AbanoubWagih94 picture AbanoubWagih94  路  7Comments

ziyotko picture ziyotko  路  4Comments

Timmmm picture Timmmm  路  4Comments

DartBot picture DartBot  路  3Comments

isoos picture isoos  路  5Comments