|
a |
|
b/.github/DeployPypi.md |
|
|
1 |
## Current Solution to release |
|
|
2 |
### Update the CHANGELOG.md |
|
|
3 |
### Update version |
|
|
4 |
- Update version in `myosuite/__init__.py` |
|
|
5 |
- Update version in `setup.py` |
|
|
6 |
- Update `.github/CHANGELOG.md` |
|
|
7 |
- Update the doc version in `docs/source/conf.py` |
|
|
8 |
|
|
|
9 |
### Make a tag |
|
|
10 |
```bash |
|
|
11 |
git tag v0.0.2 |
|
|
12 |
``` |
|
|
13 |
### Commit changes from branch `something` |
|
|
14 |
```bash |
|
|
15 |
git commit -m "[something] 0.0.2 release" |
|
|
16 |
``` |
|
|
17 |
### Push and tag branch `something` |
|
|
18 |
```bash |
|
|
19 |
git push --tags origin [branch] |
|
|
20 |
``` |
|
|
21 |
### build a new package (default repo in dist/) |
|
|
22 |
```bash |
|
|
23 |
python3 setup.py bdist_wheel --universal |
|
|
24 |
``` |
|
|
25 |
### Upload to pypi |
|
|
26 |
```bash |
|
|
27 |
python3 -m twine upload --repository pypi dist/* |
|
|
28 |
``` |
|
|
29 |
### Verify proper upload |
|
|
30 |
|
|
|
31 |
```bash |
|
|
32 |
conda create --name test_myosuite python=3.7.1 |
|
|
33 |
conda activate test_myosuite |
|
|
34 |
pip install myosuite |
|
|
35 |
python3 -c "import myosuite; print(f'MyoSuite version: {myosuite.__version__}')" |
|
|
36 |
python3 myosuite/tests/test_myo.py |
|
|
37 |
conda deactivate |
|
|
38 |
conda remove --name test_myosuite --all |
|
|
39 |
``` |
|
|
40 |
|
|
|
41 |
### Create a newly tagged release |
|
|
42 |
|
|
|
43 |
Visit [this page](https://github.com/facebookresearch/myoSuite/tags) and create the newly tagged release. |