Skip to content

Commit fde7a05

Browse files
committed
explain our release process.
1 parent 4c56129 commit fde7a05

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -323,16 +323,21 @@ We'd love your help making Nylas better. We hang out on Slack. [Join the channel
323323

324324
Please sign the [Contributor License Agreement](https://nylas.com/cla.html) before submitting pull requests. (It's similar to other projects, like NodeJS or Meteor.)
325325

326-
If you have access to the PyPI repository, you can make a new release as such:
327-
328-
```shell
329-
python setup.py test
330-
python setup.py release <major/minor/patch>
331-
git log # to verify
332-
python setup.py publish
333-
```
334-
335-
Also, don't forget to `git push --tags` to update the release tags on GitHub.
326+
### Releasing a new version
327+
328+
We have a three-step process for releasing a new version of the Python SDK. Remember that people depend on this library not breaking, so don't cut corners.
329+
1. Run the unit tests.
330+
`python setup.py test`
331+
2. Run the "system" tests. They use a live server to check that everything works as expected, so you'll need to have a valid Nylas application id and secret.
332+
In the tests directory you'll find a file named `tests/credentials.py.template`. Rename it into `credentials.py` and change the APP_ID and APP_SECRET to your own app id and secret.
333+
Run `PYTHONPATH=/your-sdk-path python tests/oauth.py` and `PYTHONPATH=/your-sdk-path python tests/system.py`.
334+
3. Finally, you can create a new release by doing:
335+
```shell
336+
python setup.py release <major/minor/patch>
337+
git log # to verify
338+
python setup.py publish
339+
git push --tags # update the release tags on GitHub.
340+
```
336341

337342
## Looking for inbox.py?
338343

0 commit comments

Comments
 (0)