Skip to content

Commit a661096

Browse files
committed
add release and update testing
1 parent d31c37a commit a661096

File tree

1 file changed

+34
-14
lines changed

1 file changed

+34
-14
lines changed

.github/CONTRIBUTING.md

Lines changed: 34 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,7 @@ If you want to have it loaded automatically, add the following to ~/.zshrc:
1313
eval "$(pyenv init -)"
1414
```
1515

16-
Second, ensure you have a version of every Python we support installed. Your versions may differ.
17-
18-
```sh
19-
pyenv install 3.4.9
20-
pyenv install 3.5.6
21-
pyenv install 3.6.3
22-
pyenv install 3.6.8
23-
pyenv global 3.6.8 3.6.3 3.5.6 3.4.9
24-
```
16+
Second, ensure you have a version of every Python we support installed.
2517

2618
Next ensure you create a virtual environment.
2719

@@ -39,14 +31,14 @@ To run the tests against every supported Python version, use `tox`.
3931
tox
4032
```
4133

42-
Alternatively, to run tests just against a specific Python version, create coverage files, and watch for changes:
34+
Alternatively, to run tests just against a specific Python environment run:
4335

4436
```sh
45-
brew install fswatch
46-
pyenv shell 3.6.8
47-
make watch
37+
tox -e py
4838
```
4939

40+
In order to see the code coverage results, open the `index.html` file in the `htmlcov` folder.
41+
5042
### Using a library locally
5143

5244
To install a library locally, use `pip` to install the library in editable mode.
@@ -63,7 +55,35 @@ from amadeus import Client
6355

6456
### Releasing
6557

66-
[TBD]
58+
On your local repository, create a release branch:
59+
60+
```sh
61+
$ git checkout -b release-x.y.z
62+
```
63+
64+
Make necessary modifications:
65+
66+
- Update version on `amadeus/version.py`
67+
- Update version on `CHANGELOG.rst`
68+
69+
Then commit the changes:
70+
71+
```sh
72+
$ git commit -am "Release version x.y.z"
73+
$ git push origin release-x.y.z
74+
```
75+
76+
Create a new Pull Request and merge.
77+
78+
On GitHub: create a new release:
79+
80+
- Go to [Releases](https://github.com/amadeus4dev/amadeus-python/releases)
81+
- Draft a new release
82+
- Tag version: vX.Y.Z
83+
84+
The new package should be automatically [deployed](https://pypi.org/project/amadeus/).
85+
86+
Generate the module version: go on https://badge.fury.io/py/amadeus.svg.
6787

6888
## How to contribute to the Amadeus Python SDK
6989

0 commit comments

Comments
 (0)