add GHA for release

[jGaboardi]

Addressing #154.

[codecov]

Codecov Report

Merging #155 (0f61481) into main (353073b) will increase coverage by 0.6%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##            main    #155     +/-   ##
=======================================
+ Coverage   75.8%   76.4%   +0.6%     
=======================================
  Files         19      19             
  Lines       1570    1570             
=======================================
+ Hits        1190    1199      +9     
+ Misses       380     371      -9     

Impacted Files	Coverage Δ
splot/_version.py	40.7% <0.0%> (+2.7%)	⬆️

[martinfleis]

Let's give it a go. Thanks!

[jGaboardi]

I will let you do the honors of merging.

[martinfleis]

@jGaboardi what should I do with the Changelog.md if I want to cut a release? With these actions, it is not updated automatically. Shall I make a manual PR with the changes (not ideal as it will be out of sync with release notes)? I can't update changelog based on the generated notes after tagging as it would mean that changes are not documented in the package itself.

I wanted to check how it is done in spaghetti but the changelog there hasn't been updated since 1.5.0 :D.

[jGaboardi]

@jGaboardi what should I do with the Changelog.md if I want to cut a release? With these actions, it is not updated automatically. Shall I make a manual PR with the changes (not ideal as it will be out of sync with release notes)? I can't update changelog based on the generated notes after tagging as it would mean that changes are not documented in the package itself.

I wanted to check how it is done in spaghetti but the changelog there hasn't been updated since 1.5.0 :D.

LOL. whoops. In spaghetti I am treating the release notes as the changelog since 1.5.0. As for here in splot, I have no strong opinion. However, it would be super nice in general if we could tie changelog updates in with the release action. For now maybe you could do the manual PR for change updates just prior to triggering the release action so that it is included with the package?

[martinfleis]

However, it would be super nice in general if we could tie changelog updates in with the release action

That is not possible, you need to update the changelog before we assign a tag. So you would need the release action to have a different trigger than a tag and git tag should be then part of then action after a push to the changelog. None of it sounds idea. Let's discuss it later today during the call.