search

pysal / tobler

Spatial interpolation, Dasymetric Mapping, & Change of Support
https://pysal.org/tobler
BSD 3-Clause "New" or "Revised" License
144 stars 30 forks source link

changelog #178

Closed knaaptime closed 7 months ago

knaaptime commented 11 months ago

working on the meta release yesterday, @sjsrey and i realized some packages like spopt and momepy arleady have a release action that generates a changelog. I'm sure i was aware of that once, but have long since forgotten. Lets adopt that action in all the subpackages. If all the subpackages follow the same conventions we can build some simple tooling to creates the changelog for meta

martinfleis commented 11 months ago

Momepy doesn't. I'm still not sure how to implement it to have an up to date changelong in docs. That cannot be generated by the release action triggered by a tag.

knaaptime commented 11 months ago

ah, my mistake. The momepy changelog looks jsut like the one from spopt and mapclassify, so i figured it came from the same spot. The mapclassify one was autogenerated the other day https://github.com/pysal/mapclassify/releases/tag/v2.6.0 (to our surprise), so something is working. Looks like the recipe is dead simple and enumerates bug fixes, enhancements and [any unlabeled] PR along with the user who created the PR

i know we've discussed a few different options for automated changelogs, without ever finding a satisfactory option (e.g. listing all commits is too much), but for the metarelease, we want to create some tooling that captures changes from across the subpackages, so we were cooking up some tooling that grabs the changelog from each subpackage and cats them into a larger one for meta (but then that depends on a structured format for each of the subpkgs)

for meta, keeping things like who issued the PR is a useful metric for us to keep track of which pacakges are getting new contributors, who's spread too thin, etc

martinfleis commented 11 months ago

@jGaboardi I summon you!

You probably know the situation best.

jGaboardi commented 11 months ago

xref https://github.com/pysal/esda/issues/250#event-9696173512

martinfleis commented 11 months ago

also https://github.com/pysal/libpysal/pull/505#issuecomment-1644690591

knaaptime commented 11 months ago

i was with serge for that, so it's actually my fault for sending us down that route in libpysal without realizing we already had one elsewhere

I think the current one in mapclassify, esda, and spopt also includes the user, which is a nice metric for meta. But the scientificpython one has more labels available