|
| 1 | +# Contributing |
| 2 | + |
| 3 | +The release process for Bitvavo SDK for Python is semi-automatic. You manually start the GitHub Action that creates |
| 4 | +the SDK package and uploads it to Python package managers. |
| 5 | + |
| 6 | +## Prerequisites |
| 7 | + |
| 8 | +To release the SDK you need to: |
| 9 | + |
| 10 | +- Complete the instructions in the [README Prerequisites](./README.md#prerequisites) |
| 11 | + |
| 12 | +## Release a new version of the SDK |
| 13 | + |
| 14 | +To update the SDK and publish your changes to the Bitvavo developer community: |
| 15 | + |
| 16 | +1. **Make your updates to the SDK** |
| 17 | + |
| 18 | + Create a branch and implement your changes to the SDK. When you have tested your code updates, make a pull request |
| 19 | + to the `master` branch. |
| 20 | + |
| 21 | +1. **Create a test package** |
| 22 | + |
| 23 | + 1. When your [pull request](https://github.com/bitvavo/python-bitvavo-api/pulls) is approved, merge your changes to |
| 24 | + the master branch. |
| 25 | + 2. Note the release number of the |
| 26 | + [latest version of the SDK published to pypi](https://pypi.org/project/python-bitvavo-api/#history) |
| 27 | + and using [semver](https://semver.org/) as your guide, decide on a version number for this release. |
| 28 | + 4. In Actions, [run the release action](https://github.com/bitvavo/python-bitvavo-api/actions/workflows/release.yml) |
| 29 | + using your new release number. |
| 30 | + The release action builds the SDK package and uploads to https://test.pypi.org/project/python-bitvavo-api/. |
| 31 | + |
| 32 | +1. **Test the package** |
| 33 | + |
| 34 | + 1. In a [clean virtual environment](https://virtualenv.pypa.io/en/stable/user_guide.html), create a new directory, |
| 35 | + then download the test package: |
| 36 | + |
| 37 | + ```python3 -m pip install --index-url https://test.pypi.org/simple/ python-bitvavo-api``` |
| 38 | + |
| 39 | + 1. Follow the instructions in [Create a simple Bitvavo implementation](./README.md#get-started) and make a sample |
| 40 | + app. |
| 41 | + When the functionality you implemented works, the package is good. If you cannot make a |
| 42 | + call, the debugger is your friend. |
| 43 | + |
| 44 | +1. **Publish the SDK** |
| 45 | + |
| 46 | + 1. Open the draft release created when you ran the release action. |
| 47 | + 1. Add a brief description about the release. |
| 48 | + |
| 49 | + This description is visible to the world in https://github.com/bitvavo/python-bitvavo-api/releases. |
| 50 | + 1. Click **Publish**. |
| 51 | + |
| 52 | + This starts the Publish action. You see the |
| 53 | + [new version available on pypi](https://pypi.org/project/python-bitvavo-api/). |
| 54 | + |
| 55 | +Now send the release message in Slack, yay. |
0 commit comments