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: 3 months ago
JSON representation
Github Action to: Check version / Test / git tag / GitHub Release / Deploy to PyPI
- Host: GitHub
- URL: https://github.com/patrick-kidger/action_update_python_project
- Owner: patrick-kidger
- License: apache-2.0
- Created: 2022-03-07T04:07:19.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-17T18:23:44.000Z (8 months ago)
- Last Synced: 2025-06-09T18:49:23.081Z (5 months ago)
- Topics: action, actions, github-actions, pypi, python
- Homepage:
- Size: 21.5 KB
- Stars: 17
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
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.)
You should go to ` > Settings > Actions > General > Workflow permissions` and enable `Read and write permissions` so that releases can be made to GitHub.
### Example
```
name: Release
on:
push:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Release
uses: patrick-kidger/action_update_python_project@v7
with:
python-version: "3.11"
test-script: |
cp -r ${{ github.workspace }}/test ./test
cp ${{ github.workspace }}/pyproject.toml ./pyproject.toml
uv sync --extra dev --no-install-project --inexact
uv run --no-sync 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 mandatory arguments (for passing to `with`) that must be specified:
- `python-version`: What Python version to run everything with. Must be at least 3.11. Set to `false` to skip this (and use whatever Python you already have on the system).
- `test-script`: What test script to run. Will execute in a precreated `uv` venv, e.g. commands often look like `uv sync --foo`.
- `pypi-token`: What password or token to use when pushing to PyPI. Set to `false` to use some other already-configured authentication mechanism, e.g. from a previous job that runs `gcloud auth`.
- `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.
The following are optional arguments that come with a default value:
- `pypi-user`: What username to use when pushing to PyPI. Defaults to `'__token__'`, corresponding to the use of a PyPI token.
- `pypi-repository-url`: What PyPI repository to use. Defaults to `'https://pypi.org/'`
- `checkout`: Whether to check out the repository. Set to `false` to disable this if you've already done this in an earlier step.
- `allow-first-release`: Whether to allow a first release to PyPI. Defaults to `false`, to avoid accidentally pushing code publicly until you're ready. (We generally recommend pushing a first release manually when you're ready, but this flag can be useful if you're pushing to an internal PyPI repository that only your CD has authentication for.)
Notes on `test-script`:
- 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.
- The code from your library will have been installed into a fresh virtual environment at `./.venv` using `uv pip install`. The `uv sync` command in the example above is the appropriate invocation to install the `dev` extras from copied `pyproject.toml`, *without* also overwriting the existing install, and *without* removing the existing install.
### 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.