Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document release process #4

Merged
merged 2 commits into from
Aug 9, 2024
Merged

document release process #4

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
93de19c
document release process
Nilsty Aug 8, 2024
fb05728
update docs
Nilsty Aug 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.