Seemingly wrong specification of GitHub Action for publishing to PyPI / TestPyPI

[lmcmicu]

The code at this link:

    - name: Publish distribution 📦 to Test PyPI
      uses: pypa/gh-action-pypi-publish@master
      with:
        password: ${{ secrets.TEST_PYPI_API_TOKEN }}
        repository_url: https://test.pypi.org/legacy/
    - name: Publish distribution 📦 to PyPI
      if: startsWith(github.ref, 'refs/tags')
      uses: pypa/gh-action-pypi-publish@master
      with:
        password: ${{ secrets.PYPI_API_TOKEN }}

Does not match the usage from the README of the GitHub Action's website. Further it does not work.

In particular the above code has the following problems:

1. The user: __token__ field is missing.
2. The specified action should not be taken from the master branch. It should point to a release. Currently the latest is @release/v1.

[pradyunsg]

@webknjaz ^

[webknjaz]

Further it does not work.

It does work. If it doesn't do what you expect, maybe you've saved the token in the repo secret incorrectly (hint: check for trailing/leading spaces — it's the only problem I've seen people face; re-saving the token correctly is the solution).

• The user: __token__ field is missing.

It's unnecessary, it's already __token__ by default if unspecified. Maybe it's worth updating the action's README, though, not to include the user: entry at all in the snippets and add a separate section on "what if I want to specify non-API-token credentials?". I'd be open to merging such a PR.

• The specified action should not be taken from the master branch. It should point to a release. Currently the latest is @release/v1.

I guess so. Although, it's just an example. I don't remember if I've come up with the release-tracking branch concept by the time I wrote the tutorial document. Feel free to send a PR updating this. Although, we'd have to remember to update the tutorial if I'll ever decide to make a v2 API for that action. I think I've left it pointing to the default branch just to avoid the burden of having to remember to update the tutorial document 🤷‍♂️

[webknjaz]

This will be fixed by #1113.