Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GH actions docs inconsistency #907

Closed
rantoniuk opened this issue May 1, 2024 · 4 comments
Closed

GH actions docs inconsistency #907

rantoniuk opened this issue May 1, 2024 · 4 comments
Labels
awaiting-reply Waiting for response docs Improvements or additions to documentation unresponsive

Comments

@rantoniuk
Copy link

  1. The GH Action pages are duplicated:
  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).

@rantoniuk rantoniuk added the docs Improvements or additions to documentation label May 1, 2024
@rantoniuk
Copy link
Author

Happy to help via a PR if needed.

@codejedi365
Copy link
Contributor

@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!

@codejedi365 codejedi365 added the awaiting-reply Waiting for response label May 3, 2024
Copy link

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.

Copy link

This issue was closed because no response was received.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale May 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting-reply Waiting for response docs Improvements or additions to documentation unresponsive
Projects
None yet
Development

No branches or pull requests

2 participants