gha for release notes - #543

[jGaboardi]

gha for release notes - #543

• decide on tags for release
• the release action for spopt and the one here in momepy differ considerably -- will have to see how adding the "create release notes" interacts here
• what else?

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.0%. Comparing base (4037c70) to head (8c91d28).
Report is 44 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##            main    #604     +/-   ##
=======================================
+ Coverage   97.4%   98.0%   +0.6%     
=======================================
  Files         26      37     +11     
  Lines       4328    6068   +1740     
=======================================
+ Hits        4214    5946   +1732     
- Misses       114     122      +8     

[martinfleis]

On the categories, something like

• API changes
• Enhancements
• Bug fixes
• Deprecations
• Documentation
• Other

? I am not a fan of having type (e.g. enhancement) and content (e.g. preprocessing) mixed together. I also don't think that refactoring needs to be included as it should not affect user in any way.

[martinfleis]

I suppose that this will conflict with Create GitHub Release above

[jGaboardi]

I suppose that this will conflict with Create GitHub Release above

Yeah, more than likely. We will have to work that out iteratively seems like.

[martinfleis]

We need one or the other. Also note that removing the one above will break the last one which uses steps.create_release.outputs.upload_url. In any case, actions/create-release is archived so we shall find a new way of doing things.

[jGaboardi]

I actually think things are more simple than I thought. We can simply prune down the current momepy action to get our desired result. That final step

We can see in the v0.7.0 release there are 3 assets there.

• momepy-0.7.0.tar.gz
• Source code (zip)
• Source code (tar.gz)

However, momepy-0.7.0.tar.gz and Source code (tar.gz) are the exact same thing, just different names - that's what Upload Release Asset (sdist) to GitHub is doing (and it's not needed).

I'm going to make some adjustments and push up (what I hope is) the fix.

[jGaboardi]

On the categories, something like

• API changes
• Enhancements
• Bug fixes
• Deprecations
• Documentation
• Other

? I am not a fan of having type (e.g. enhancement) and content (e.g. preprocessing) mixed together. I also don't think that refactoring needs to be included as it should not affect user in any way.

So maybe like:

• categories
  • title -- API changes
    • label -- refactor?
  • title -- Enhancements
    • label -- enhancements
  • title -- Bug fixes
    • label -- bug
  • title -- Deprecations
    • label -- ?
  • title -- Documentation
    • label -- documentation
  • title -- Other
    • label -- *

The thing is that we don't have labels for all and will have go back through all Issues & PRs to add those new labels once they are created. @martinfleis

[martinfleis]

The thing is that we don't have labels for all and will have go back through all Issues & PRs to add those new labels once they are created

I am happy to do that.

• categories
  • title -- API changes
    • label -- refactor? - refactor is not API change. API change is stuff like change of a default arg value. We don't have a label for that and we haven't done any API changes. All stuff regarding the API model is considered enhancement as those are new functions that live alongside the old.
  • title -- Enhancements
    • label -- enhancements
  • title -- Bug fixes
    • label -- bug
  • title -- Deprecations
    • label -- ? - we need a label deprecation
  • title -- Documentation
    • label -- documentation
  • title -- Other
    • label -- *

[jGaboardi]

refactor is not API change. API change is stuff like change of a default arg value. We don't have a label for that and we haven't done any API changes. All stuff regarding the API model is considered enhancement as those are new functions that live alongside the old.

Roger that. OK, I'll add api and deprecation labels within release.yml then go ahead and create those labels in the repo.

[jGaboardi]

@martinfleis this is ready for review. once merged I will see about a tag + release of v0.8.0-alpha1

[jGaboardi]

Same osmnx error causing failures -- https://github.com/pysal/momepy/actions/runs/9530670355/job/26270797522?pr=604#step:5:544