diff --git a/README.md b/README.md index 369c6a5..0733973 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,21 @@ -# semantic-release-pypi -semantic-release plugin to publish a python package to PyPI +# 📦🐍 semantic-release-pypi +[semantic-release](https://semantic-release.gitbook.io/semantic-release/) plugin to publish a python package to PyPI + + + npm latest version + + + Build states + + +## Requirements + +- [Node.js](https://semantic-release.gitbook.io/semantic-release/support/node-version) >= 18.0.0 +- Python 3 +- setuptools - other packaging tools like Poetry or Hatch are not supported +- `version` must **not be set** inside `setup.py` + +## Steps | Step | Description | ---- | ----------- @@ -7,8 +23,6 @@ semantic-release plugin to publish a python package to PyPI | ```prepare``` | Update the version in ```setup.cfg``` and create the distribution packages | ```publish``` | Publish the python package to the specified repository (default: pypi) -# Configuration - ## Environment variables | Variable | Description | Required | Default @@ -79,5 +93,11 @@ source init.sh - Fork from this repository - Run `source init.sh` +- Add your changes - Make sure your code passes all unit tests by running `yarn test` -- Issue a PR \ No newline at end of file +- Run `yarn lint` to ensure your code adheres to the linting rules +- Issue a PR + +## Alternatives + +[Python Semantic Release](https://github.com/python-semantic-release/python-semantic-release) \ No newline at end of file