Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/patrick-kidger/action_update_python_project

Github Action to: Check version / Test / git tag / GitHub Release / Deploy to PyPI
https://github.com/patrick-kidger/action_update_python_project

action actions github-actions pypi python

Last synced: about 1 month ago
JSON representation

Github Action to: Check version / Test / git tag / GitHub Release / Deploy to PyPI

Awesome Lists containing this project

README 

        
Update Python project:
Check version / Test / git tag / GitHub Release / Deploy to PyPI



This is a GitHub Action to automate deployment of a new version of a Python project.



This action will:

- Check out your code;

- Check the version of your code against the latest version available on PyPI;

- If your code has a newer version:

    - It will build both an sdist and a wheel;

    - It will run tests against both;

    - If both pass:

        - An annotated git tag is added;

        - A GitHub Release is made

        - The sdist and wheel are both uploaded to PyPI.



### Usage



Requires a Linux runner.



Assumes that your project uses a `pyproject.toml` file; the `project.name` and `project.version` fields will be accessed. In particular the latter must not be dynamic. (You should put `__version__ = importlib.metadata.version(your_package_name)` in your top-level `__init__.py` file to get the version at runtime.)



### Example



```

name: Release



on:

  push:

    branches:

      - main



jobs:

  build:

    runs-on: ubuntu-latest

    steps:

      - name: Release

        uses: patrick-kidger/action_update_python_project@v1

        with:

            python-version: "3.11"

            test-script: |

                python -m pip install pytest

                cp -r ${{ github.workspace }}/test ./test

                pytest

            pypi-token: ${{ secrets.pypi_token }}

            github-user: your-username-here

            github-token: ${{ github.token }}  # automatically created token

```



This will run every time the `main` branch is updated. If the version has updated, then it will trigger things as described above.



### Options



The following are options for passing to `with`:



- `python-version`: What Python version to run everything with. Must be at least 3.11.

- `test-script`: What test script to run.

- `pypi-user`: What username to use when pushing to PyPI. Defaults to `__token__`, corresponding to the use of a PyPI token.

- `pypi-token`: What password or token to use when pushing to PyPI.

- `github-user`: What GitHub user to use when authenticating the release with GitHub.

- `github-token`: What GitHub token to use when authenticating the release with GitHub.



Notes on `test-script`:



- Note that it runs in a temporary directory. Thus you will need to copy your tests over as in the example above. This is to avoid spuriously passing tests: it can happen that files have been incorrectly left out of the sdist/wheel, but are still available through the repository itself.

- Any `"` characters must be escaped as `\"`.

- The exit code of this script is used to determine whether the tests count as having passed or not. `0` is a pass; everything else is a failure.



### FAQ



**I'm getting a random/spurious failure.**



If you call this action shortly (<5 minutes?) after it triggers (and has pushed an update to PyPI) then sometimes the second invocation won't see that the updated version exists yet, so it will think that it has a new version -- and will attempt to start the update process itself. This should just be a harmless failure.