updated cd workflow and Python Semantic Release table in pyproject.toml

[ttimbers]

This new cd workflow the the following changes:

• uses a GHA for Python Semantic Release instead of a command Python Semantic Release version 8.3.0
• upgraded to
• drops the now redundant GHA commands (Install poetry, Install package)
• added a conditional to publish to the package repositories (only do this if semantic release has a new release
• used a GHA to generate the GitHub release

Note: there is a bug in the newest versions of Python Semantic Release that prevent poetry from working (see here). Thus we are pinning to version 8.3.0 for now until the fix is merged to main/master.

[ttimbers]

This changes require the new table in pyproject.toml to look like this:

[tool.semantic_release]
version_toml = [
    "pyproject.toml:tool.poetry.version",
] # version location
branch = "main"                             
changelog_file = "CHANGELOG.md"             
build_command = "pip install poetry && poetry build"              
upload_to_release = true                    
upload_to_pypi = true                     

A couple notes:

• patch_without_tag was removed in v8.0.0 ... (see: Was patch_without_tag removed or was the name just changed? python-semantic-release/python-semantic-release#793)
• I don't think we need to worry about handing the dists folder anymore

I think the only docs we need to update are the book for this table? Currently working here to do this.

[TomasBeuzen]

Cool this looks great to me - I remember having quite a bit of trouble getting PSR to work with GH Actions. Fantastic that they have their own action now, seems to have simplified things.

[TomasBeuzen]

@ttimbers - we want to modify the pyproject.toml file of the cookiecutter too right? To reflect these changes, i.e., change to what you have above (I can do it, just wondering if there was a reason we didn't yet):

[tool.semantic_release]
version_toml = [
    "pyproject.toml:tool.poetry.version",
] # version location
branch = "main"                             
changelog_file = "CHANGELOG.md"             
build_command = "pip install poetry && poetry build"              
upload_to_release = true                    
upload_to_pypi = true                     

[ttimbers]

We actually do not need:

upload_to_release = true                    
upload_to_pypi = true 

So it just needs to be:

[tool.semantic_release]
version_toml = [
    "pyproject.toml:tool.poetry.version",
] # version location
branch = "main"                             
changelog_file = "CHANGELOG.md"             
build_command = "pip install poetry && poetry build"  

And yes, we should edit the pyproject.toml file of the cookiecutter too right! I forgot we had that in there because in the example I was working through I initially set it up without ci or cd, and then added it manually after! Will make this change now!

[ttimbers]

oops! I accidentally directly added it to main here: 62fdd3a

Apologies, should have branched and PR'ed it (meant to but was using the pen tool and clicked the wrong radio button). Should we add main branch protection to this repo 😅