1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
Contributing guide
==================
Thanks for your interest in contributing to wstool.
Any kinds of contributions are welcome: Bug reports, Documentation, Patches.
The core functionality of abstracting over different version control systems is contained in the library project https://github.com/vcstools/vcstools.
Developer Environment
---------------------
For many tasks, it is okay to just develop using a single installed python version. But if you need to test/debug the project in multiple python versions, you need to install those versions::
1. (Optional) Install multiple python versions
1. (Optional) Install [pyenv](https://github.com/pyenv/pyenv-installer) to manage python versions
2. (Optional) Using pyenv, install the python versions used in testing::
pyenv install 2.7.16
pyenv install 3.6.8
It may be okay to run and test python against locally installed libraries, but if you need to have a consistent build, it is recommended to manage your environment using `virtualenv <https://virtualenv.readthedocs.org/en/latest/>`_::
$ virtualenv ~/wstool_venv
$ source ~/wstool_venv/bin/activate
Testing
-------
Prerequisites:
* The tests require git, mercurial, bazaar and subversion to be installed.
Also you need to install python test support libraries::
# install python dependencies
$ pip install .[test]
# optional also use local vcstools sources directly
$ pip install --editable /path/to/vcstools_source
Then you can use different commands to run various test scopes::
# run all tests using nose
$ nosetests
# run one test using nose
$ nosetests {testname}
# run all tests with coverage check
$ python setup.py test
# run all tests using python3
$ python3 setup.py test
# run all tests against multiple python versions (same as in travis)
$ tox
Releasing
---------
* Upgrade vcstools dependency version in `requirements.txt`
* Update `src/vcstools/__version__.py`
* Check `doc/changelog` is up to date
* Check `stdeb.cfg` is up to date with OSRF buildfarm distros
* prepare release dependencies::
pip install --upgrade setuptools wheel twine
* Upload to testpypi::
python3 setup.py sdist bdist_wheel
twine upload --repository testpypi dist/*
* Check testpypi download files and documentation look ok
* Actually release::
twine upload dist/*
* Create and push tag::
git tag x.y.z
git push
git push --tags
|
