ploomber / pkgmt

A toolkit for managing Python packages. 📦🐍
https://pkgmt.readthedocs.io/
MIT License
10 stars 10 forks source link

Better checks for Changelog entries #77

Closed neelasha23 closed 8 months ago

neelasha23 commented 9 months ago

Closes #76

neelasha23 commented 9 months ago

Please review @edublancas

edublancas commented 9 months ago

@bryannho please dome some testing

you can open a dummy PR in this repo to test it: https://github.com/ploomber/dummy

just ensure you're installing pkgmt from the right place

pip install https://github.com/neelasha23/pkgmt@issue76

if you have questions about installation and testing let us know

bryannho commented 9 months ago

@edublancas @neelasha23 Did some testing, you can see my tests here: https://github.com/ploomber/dummy/pull/64

Tested these cases:

All cases work as expected except for the main one: If Changelog.md is not modified at all, but another file is, the test passes when it should fail. Meaning this catch isn't working for some reason. See this commit and the CI check. You can also look at the files changed to see I didn't modify the changelog. LMK if I'm testing incorrectly but I'm pretty sure this is an error since the other cases behaved as expected.

Another note is I had to modify ci.yml here, so to make these changes work in other repos we'll have to make the same change in each one.

neelasha23 commented 8 months ago

Fixed the bug that @bryannho mentioned. here's the commit and the check

Please review again

@bryannho @edublancas

edublancas commented 8 months ago

@bryannho don't forget to perform reviews, remember that we have a 24 hours SLA