search

python-semantic-release / python-semantic-release

Automating Releases via SemVer and Commit Message Conventions
https://python-semantic-release.readthedocs.io
MIT License
812 stars 248 forks source link

GH actions docs inconsistency #907

Closed rantoniuk closed 3 weeks ago

rantoniuk commented 5 months ago

  1. The GH Action pages are duplicated:

  2. The action does not run version and publish per documentation. It runs only version, at least that's what I see from: https://github.com/python-semantic-release/python-semantic-release/blob/master/action.sh#L97

(and yes, it should stay this way or it there should be a flag to disable publishing for non PyPi builds).

rantoniuk commented 5 months ago

Happy to help via a PR if needed.

codejedi365 commented 5 months ago

@rantoniuk

  1. The GH Action pages are duplicated:

As the pages both address GitHub actions, they do not cover the same material (so its not an easy delete of one) and I agree that it is confusing that it is not all in one. If you would be willing to consolidate the two contents into one via PR that would always be helpful. If you decide to make a PR, please consolidate the docs into the page under automatic-releases and delete the top level one. I have been meaning to get around to a doc refactor to include other VCS systems like GitLab & Bitbucket examples which will also go under automatic-releases. Your help is appreciated.

  1. The action does not run version and publish per documentation. It runs only version, at least that's what I see from: https://github.com/python-semantic-release/python-semantic-release/blob/master/action.sh#L97

(and yes, it should stay this way or it there should be a flag to disable publishing for non PyPi builds).

This seems to be a remanent from prior to v8 release. Yes, this action should not perform publish but instead users should use our publish specific action, upload-to-gh-release, after handling their own upload to PyPi-like registry. The example of this workflow is listed on the upload action's Readme.

Thank you for helping improve the Python Semantic Release project & documentation!

github-actions[bot] commented 5 months ago

This issue has not received a response in 14 days. If no response is received in 7 days, it will be closed. We look forward to hearing from you.

github-actions[bot] commented 4 months ago

This issue was closed because no response was received.

codejedi365 commented 2 months ago

Requires update to adjustments made in #1004