search

linkfluence / radarly-py

Python client for Radarly API
Apache License 2.0
10 stars 6 forks source link

Simple pipeline to deploy radarly-py to PyPi #6

Closed adriamanu closed 2 years ago

adriamanu commented 2 years ago

Feature

Simple CD pipeline to build the radarly-py python package, publish it to TestPyPi and then to PyPi. When a PR is opened the package is build and sent to TestPyPi, using a flag so that it doesn't trigger errors if the files are already existing on the test repository (in case a PR is opened, closed and then reopened). When there is a new commit to master, it will go to the previous steps and at the end, if it has been a success, it will be deployed to PyPi.

Github actions structure:

. └── .github / ├── actions/ │ ├── build/action.yml │ ├── testpypi/action.yml │ └── pypi/action.yml └── workflows/ ├── pull-request └── push-master

Steps have been splitted accross several actions folder in order to be reusable. If you need to add more steps and be able to do composition, add your actions on the actions//action.yml and simply call it in the worklow.

Secret

These secrets need to be added to the repository in order to be able to deploy to PyPi and TestPyPi: TEST_PYPI_API_TOKEN and PYPI_API_TOKEN. These are the api keys from https://test.pypi.org/ and https://pypi.org/ for the account that own radarly-py repository.