documentation

[jonapich]

see it formatted here: https://github.com/coveooss/pypi-publish-with-poetry/tree/feature/documentation

[louis-bompart]

Documentation LGTM concerning what's the project is. I'll only give a consultative review tho (no ✔️ nor ❌) because of my lack of knowledge of the python environment.

Ideas/improvement:
From my understanding, the 'automatic next version' will always be the x.y.z+1 where, {x,y,z} is the 'greatest' semantic version. And this, regardless of the changeset that occurred since {x.y.z}.

An improvement would be to use the git history between the git ref being built & the greatest tag on the main or branch version to define the latest version. (this would ofc work only if the commits are semantics)

https://github.com/relekang/python-semantic-release seems to do just that and has a fair amount of traction. ( 90k download last month, 363 ⭐ ). Did you check it out?

Regardless of the above, GH Release associated with the tag would be nice too.

[jonapich]

An improvement would be to use the git history between the git ref being built & the greatest tag on the main or branch version to define the latest version. (this would ofc work only if the commits are semantics)

I did fool around with such a tool, but I found it was adding one more layer of technicality and human error over the repository for not much gain. They're probably far more useful / necessary in high-velocity repositories where merges occur frequently.

That being said, I realize the current functionality prevents users from using such a system, so I wrote #4 and #5 to ensure we can at least play hand-in-hand.

Regardless of the above, GH Release associated with the tag would be nice too.

Hey that's right! #3 😄

[klalumiere]

❤️

As a new feature, do you think it would worth it to parameterize the server so that we can use an internal one? 🤔