Skip to content

Commit 0c9760b

Browse files
author
Michael Hart
committed
Improve build and test instruction in release checklist
1 parent 47bbc9b commit 0c9760b

File tree

1 file changed

+22
-10
lines changed

1 file changed

+22
-10
lines changed

docs/developer_guide/release_checklist.rst

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,12 @@ This should be done in a clean directory.
7070

7171
.. code-block:: bash
7272
73-
$ virtualenv env
73+
$ virtualenv build
7474
$ . env/bin/activate
75-
(env) $ git clone https://github.com/DMSC-Instrument-Data/lewis.git
76-
(env) $ cd lewis
77-
(env) $ python setup.py sdist bdist_wheel
75+
(build) $ git clone https://github.com/DMSC-Instrument-Data/lewis.git
76+
(build) $ cd lewis
77+
(build) $ python setup.py sdist bdist_wheel
78+
(build) $ deactivate
7879
7980
8081
Test PyPI Package
@@ -87,12 +88,23 @@ Make sure tests are run in a fresh virtual environment:
8788

8889
.. code-block:: bash
8990
90-
$ virtualenv test
91-
$ . test/bin/activate
92-
(test) $ git clone https://github.com/DMSC-Instrument-Data/lewis.git
93-
(test) $ cd lewis
94-
(test) $ pip install -e ".[dev]"
95-
(test) $ tox
91+
$ virtualenv targz
92+
$ . targz/bin/activate
93+
(targz) $ pip install lewis/dist/lewis-X.Y.Z.tar.gz
94+
(targz) $ lewis linkam_t95
95+
...
96+
(targz) $ deactivate
97+
98+
$ virtualenv whl
99+
$ . whl/bin/activate
100+
(whl) $ pip install lewis/dist/lewis-X.Y.Z-py2.py3-none-any.whl
101+
(whl) $ lewis linkam_t95
102+
...
103+
(whl) $ deactivate
104+
105+
Since these are release packages, unit tests aren't available. Run a few manual
106+
tests against the packaged version of Lewis to double check that things still
107+
work as expected.
96108

97109

98110
Git Release

0 commit comments

Comments
 (0)