diff --git a/README.md b/README.md index 774947c..1c2c198 100644 --- a/README.md +++ b/README.md @@ -83,3 +83,12 @@ Exit the virtualenv ``` deactivate ``` +--- +## Releasing new versions to PyPi + +The Robotframework-TerraformLibrary is released on [PyPi.org](https://pypi.org/project/robotframework-terraformlibrary/). +To release a new version of the library to PyPi, a few steps are needed. +- update the version number in [pyproject.toml](pyproject.toml) +- rebuild the keyword documentation with the command `poetry run libdoc` +- create a pull request with the updated pyproject.toml and the keyword documentation under `docs/terraformlibrary.html` +- once the pull request is merged a new github release can be created and published which will trigger a [github action](.github/workflows/publish.yml) publishing the release to PyPi via a trusted publisher setup. \ No newline at end of file