xref: /aosp_15_r20/external/yapf/HACKING.rst (revision 7249d1a64f4850ccf838e62a46276f891f72998e)
1*7249d1a6SKrzysztof KosińskiRunning YAPF on itself
2*7249d1a6SKrzysztof Kosiński----------------------
3*7249d1a6SKrzysztof Kosiński
4*7249d1a6SKrzysztof KosińskiTo run YAPF on all of YAPF::
5*7249d1a6SKrzysztof Kosiński
6*7249d1a6SKrzysztof Kosiński $ PYTHONPATH=$PWD/yapf python -m yapf -i -r .
7*7249d1a6SKrzysztof Kosiński
8*7249d1a6SKrzysztof KosińskiTo run YAPF on just the files changed in the current git branch::
9*7249d1a6SKrzysztof Kosiński
10*7249d1a6SKrzysztof Kosiński $ PYTHONPATH=$PWD/yapf python -m yapf -i $(git diff --name-only @{upstream})
11*7249d1a6SKrzysztof Kosiński
12*7249d1a6SKrzysztof KosińskiReleasing a new version
13*7249d1a6SKrzysztof Kosiński-----------------------
14*7249d1a6SKrzysztof Kosiński
15*7249d1a6SKrzysztof Kosiński* Run tests: python setup.py test
16*7249d1a6SKrzysztof Kosiński  [don't forget to run with Python 2.7 and 3.6]
17*7249d1a6SKrzysztof Kosiński
18*7249d1a6SKrzysztof Kosiński* Bump version in yapf/__init__.py
19*7249d1a6SKrzysztof Kosiński
20*7249d1a6SKrzysztof Kosiński* Build source distribution: python setup.py sdist
21*7249d1a6SKrzysztof Kosiński
22*7249d1a6SKrzysztof Kosiński* Check it looks OK, install it onto a virtualenv, run tests, run yapf as a tool
23*7249d1a6SKrzysztof Kosiński
24*7249d1a6SKrzysztof Kosiński* Build release: python setup.py sdist bdist_wheel
25*7249d1a6SKrzysztof Kosiński
26*7249d1a6SKrzysztof Kosiński* Push to PyPI: twine upload dist/*
27*7249d1a6SKrzysztof Kosiński
28*7249d1a6SKrzysztof Kosiński* Test in a clean virtualenv that 'pip install yapf' works with the new version
29*7249d1a6SKrzysztof Kosiński
30*7249d1a6SKrzysztof Kosiński* Commit the version bump; add tag with git tag v<VERSION_NUM>; git push --tags
31*7249d1a6SKrzysztof Kosiński
32*7249d1a6SKrzysztof KosińskiTODO: discuss how to use tox to make virtualenv testing easier.
33