[UDT] Readme, add release chapter

This commit is contained in:
Benedek Racz 2019-07-29 14:21:26 +02:00
parent d3caa273d6
commit a5dcd7ac26

View File

@ -79,7 +79,43 @@ One (non stanbdard) package, **pypiwin32** is needed by wexpect.
Thanks for any contributing!
### Test
To run test, enter into the folder of the wexpect's repo then:
`python -m pytest tests`
`python -m unittest`
Note that `tests.test_constructor.TestCaseConstructor.test_constructor` test fails due to
[STDERR isn't handled properly #2](https://github.com/raczben/wexpect/issues/2).
### Release
The wexpect uses [pbr](https://docs.openstack.org/pbr/latest/) for managing releasing procedures.
*Pre-release tasks:*
- First of all be sure that your modification is good, by running the tests.
- Commit your modification.
- Create a test build `python -m setup sdist`
- Upload the test `twine upload -r testpypi dist\wexpect-<VERSION>.tar.gz` (You must install twine first.)
- create virtualenv `virtualenv wexpectPy`
- Activate the virtualenv `.\Scripts\activate.bat`
- Install the test build `python -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple wexpect`
- run `python -c "import wexpect;print(wexpect.__version__)"`
*Release tasks:*
- Tag your commit (see the version tag format.)
- Run `python -m setup sdist`
- Upload the archive using: `twine upload dist/wexpect-<VERSION>.tar.gz`
- create virtualenv `virtualenv wexpectPy2`
- Activate the virtualenv `.\Scripts\activate.bat`
- Install the test build `python -m pip install wexpect`
- run `python -c "import wexpect;print(wexpect.__version__)"`
Test
This means that you should r