search

pysal / submodule_template

This provides a template for submodules to use in the PySAL project
BSD 3-Clause "New" or "Revised" License
2 stars 10 forks source link

release notes debate #35

Open jGaboardi opened 1 year ago

jGaboardi commented 1 year ago

Automated release notes creation vs. gitcount.ipymb

xref this comment in pysal/libpysal#490

I have had success with the GHA for creating release notes, but we have to stay on top of adding labels to the Issues & PRs for that.

jGaboardi commented 1 year ago

FWIW, I am in favor of the automated release notes action.

jGaboardi commented 1 year ago

Shall I include this in #32 or wait until another PR?

jGaboardi commented 1 year ago

I'll go and add it into #32.

martinfleis commented 1 year ago

I still don't know how to ensure the up-to-date changelog.md is part of the release and rendered in the docs with a clean tag with this GHA generated notes. Is there any solution? If not it is no go for me.

jGaboardi commented 1 year ago

@martinfleis That's a fair point, but is the ChangeLog that is generated on GH not enough (e.g. here), even if there isn't a specific "changelog.md" file? As for a changelog being rendered within docs, I am not aware that it is/was being done anywhere within the PySAL ecosystem besides in momepy (but maybe I'm wrong?).

martinfleis commented 1 year ago

As for a changelog being rendered within docs, I am not aware that it is/was being done anywhere within the PySAL ecosystem

That is possible but it is imo a good practice to have in the docs as well. If you look at any major project, there always some form of it in the docs.