Skip to content

Commit c8e19d8

Browse files
RKrahlRKrahl
committed
Review formatting of the changelog and include it in the source
distribution.
1 parent 38b9a7a commit c8e19d8

File tree

3 files changed

+178
-129
lines changed

3 files changed

+178
-129
lines changed

‎CHANGES.rst

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
Changelog
2+
=========
3+
4+
0.5.1 (2020-02-14)
5+
~~~~~~~~~~~~~~~~~~
6+
7+
Bug fixes and minor changes
8+
---------------------------
9+
10+
+ Fix failing documentation build.
11+
12+
0.5.0 (2020-02-14)
13+
~~~~~~~~~~~~~~~~~~
14+
15+
New features
16+
------------
17+
18+
+ `#3`_, `#35`_: add a scope to dependencies.
19+
(Thanks to JoeSc and selenareneephillips!)
20+
21+
Bug fixes and minor changes
22+
---------------------------
23+
24+
+ `#34`_: failing test with pytest 4.2.0 and newer.
25+
26+
+ Use setuptools_scm to manage the version number.
27+
28+
.. _#35: https://github.com/RKrahl/pytest-dependency/pull/35
29+
.. _#34: https://github.com/RKrahl/pytest-dependency/issues/34
30+
.. _#3: https://github.com/RKrahl/pytest-dependency/issues/3
31+
32+
0.4.0 (2018-12-02)
33+
~~~~~~~~~~~~~~~~~~
34+
35+
Incompatible changes
36+
--------------------
37+
38+
+ Require pytest version 3.6.0 or newer. This implicitly drops
39+
support for Python 2.6 and for Python 3.3 and older.
40+
41+
Bug fixes and minor changes
42+
---------------------------
43+
44+
+ `#24`_, `#25`_: get_marker no longer available in pytest 4.0.0.
45+
(Thanks to Rogdham!)
46+
47+
+ `#28`_: Applying markers directly in parametrize is no longer
48+
available in 4.0.
49+
50+
.. _#28: https://github.com/RKrahl/pytest-dependency/issues/28
51+
.. _#25: https://github.com/RKrahl/pytest-dependency/pull/25
52+
.. _#24: https://github.com/RKrahl/pytest-dependency/issues/24
53+
54+
0.3.2 (2018-01-17)
55+
~~~~~~~~~~~~~~~~~~
56+
57+
Bug fixes and minor changes
58+
---------------------------
59+
60+
+ `#5`_: properly register the dependency marker.
61+
62+
+ Do not add the documentation to the source distribution.
63+
64+
.. _#5: https://github.com/RKrahl/pytest-dependency/issues/5
65+
66+
0.3.1 (2017-12-26)
67+
~~~~~~~~~~~~~~~~~~
68+
69+
Bug fixes and minor changes
70+
---------------------------
71+
72+
+ `#17`_: Move the online documentation to Read the Docs.
73+
74+
+ Some improvements in the documentation.
75+
76+
.. _#17: https://github.com/RKrahl/pytest-dependency/issues/17
77+
78+
0.3 (2017-12-26)
79+
~~~~~~~~~~~~~~~~
80+
81+
New features
82+
------------
83+
84+
+ `#7`_: Add a configuration switch to implicitly mark all tests.
85+
86+
+ `#10`_: Add an option to ignore unknown dependencies.
87+
88+
Incompatible changes
89+
--------------------
90+
91+
+ Prepend the class name to the default test name for test class
92+
methods. This fixes a potential name conflict, see `#6`_.
93+
94+
If your code uses test classes and you reference test methods by
95+
their default name, you must add the class name. E.g. if you have
96+
something like:
97+
98+
.. code-block:: python
99+
100+
class TestClass(object):
101+
102+
@pytest.mark.dependency()
103+
def test_a():
104+
pass
105+
106+
@pytest.mark.dependency(depends=["test_a"])
107+
def test_b():
108+
pass
109+
110+
you need to change this to:
111+
112+
.. code-block:: python
113+
114+
class TestClass(object):
115+
116+
@pytest.mark.dependency()
117+
def test_a():
118+
pass
119+
120+
@pytest.mark.dependency(depends=["TestClass::test_a"])
121+
def test_b():
122+
pass
123+
124+
If you override the test name in the :func:`pytest.mark.dependency`
125+
marker, nothing need to be changed.
126+
127+
Bug fixes and minor changes
128+
---------------------------
129+
130+
+ `#11`_: show the name of the skipped test.
131+
(Thanks asteriogonzalez!)
132+
133+
+ `#13`_: Do not import pytest in setup.py to make it compatible with
134+
pipenv.
135+
136+
+ `#15`_: tests fail with pytest 3.3.0.
137+
138+
+ `#8`_: document incompatibility with parallelization in
139+
pytest-xdist.
140+
141+
+ Clarify in the documentation that Python 3.1 is not officially
142+
supported because pytest 2.8 does not support it. There is no known
143+
issue with Python 3.1 though.
144+
145+
.. _#15: https://github.com/RKrahl/pytest-dependency/issues/15
146+
.. _#13: https://github.com/RKrahl/pytest-dependency/issues/13
147+
.. _#11: https://github.com/RKrahl/pytest-dependency/pull/11
148+
.. _#10: https://github.com/RKrahl/pytest-dependency/issues/10
149+
.. _#8: https://github.com/RKrahl/pytest-dependency/issues/8
150+
.. _#7: https://github.com/RKrahl/pytest-dependency/issues/7
151+
.. _#6: https://github.com/RKrahl/pytest-dependency/issues/6
152+
153+
0.2 (2017-05-28)
154+
~~~~~~~~~~~~~~~~
155+
156+
New features
157+
------------
158+
159+
+ `#2`_: Add documentation.
160+
161+
+ `#4`_: Add a depend() function to add a dependency to a test at
162+
runtime.
163+
164+
.. _#4: https://github.com/RKrahl/pytest-dependency/issues/4
165+
.. _#2: https://github.com/RKrahl/pytest-dependency/issues/2
166+
167+
0.1 (2017-01-29)
168+
~~~~~~~~~~~~~~~~
169+
170+
+ Initial release as an independent Python module.
171+
172+
This code was first developed as part of a larger package,
173+
`python-icat`_, at Helmholtz-Zentrum Berlin für Materialien und
174+
Energie.
175+
176+
.. _python-icat: https://github.com/icatproject/python-icat

‎MANIFEST.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
include .version
2+
include CHANGES.rst
23
include LICENSE.txt
34
include MANIFEST.in
45
include README.rst

‎doc/src/changelog.rst

Lines changed: 1 addition & 129 deletions
Original file line numberDiff line numberDiff line change
@@ -1,129 +1 @@
1-
History of changes to pytest-dependency
2-
=======================================
3-
4-
0.5.1 (2020-02-14)
5-
6-
Bug fixes and minor changes
7-
+ Fix failing documentation build.
8-
9-
0.5.0 (2020-02-14)
10-
New features
11-
+ `#3`_, `#35`_: add a scope to dependencies.
12-
(Thanks to JoeSc and selenareneephillips!)
13-
14-
Bug fixes and minor changes
15-
+ `#34`_: failing test with pytest 4.2.0 and newer.
16-
+ Use setuptools_scm to manage the version number.
17-
18-
.. _#3: https://github.com/RKrahl/pytest-dependency/issues/3
19-
.. _#34: https://github.com/RKrahl/pytest-dependency/issues/34
20-
.. _#35: https://github.com/RKrahl/pytest-dependency/pull/35
21-
22-
0.4.0 (2018-12-02)
23-
Incompatible changes
24-
+ Require pytest version 3.6.0 or newer. This implicitly drops
25-
support for Python 2.6 and for Python 3.3 and older.
26-
27-
Bug fixes and minor changes
28-
+ `#24`_, `#25`_: get_marker no longer available in pytest 4.0.0.
29-
(Thanks to Rogdham!)
30-
+ `#28`_: Applying markers directly in parametrize is no
31-
longer available in 4.0.
32-
33-
.. _#24: https://github.com/RKrahl/pytest-dependency/issues/24
34-
.. _#25: https://github.com/RKrahl/pytest-dependency/pull/25
35-
.. _#28: https://github.com/RKrahl/pytest-dependency/issues/28
36-
37-
0.3.2 (2018-01-17)
38-
Bug fixes and minor changes
39-
+ `#5`_: properly register the dependency marker.
40-
+ Do not add the documentation to the source distribution.
41-
42-
.. _#5: https://github.com/RKrahl/pytest-dependency/issues/5
43-
44-
0.3.1 (2017-12-26)
45-
Bug fixes and minor changes
46-
+ `#17`_: Move the online documentation to Read the Docs.
47-
+ Some improvements in the documentation.
48-
49-
.. _#17: https://github.com/RKrahl/pytest-dependency/issues/17
50-
51-
0.3 (2017-12-26)
52-
New features
53-
+ `#7`_: Add a configuration switch to implicitly mark all
54-
tests.
55-
+ `#10`_: Add an option to ignore unknown dependencies.
56-
57-
Incompatible changes
58-
+ Prepend the class name to the default test name for test class
59-
methods. This fixes a potential name conflict, see `#6`_.
60-
61-
If your code uses test classes and you reference test methods
62-
by their default name, you must add the class name. E.g. if
63-
you have something like:
64-
65-
.. code-block:: python
66-
67-
class TestClass(object):
68-
69-
@pytest.mark.dependency()
70-
def test_a():
71-
pass
72-
73-
@pytest.mark.dependency(depends=["test_a"])
74-
def test_b():
75-
pass
76-
77-
you need to change this to:
78-
79-
.. code-block:: python
80-
81-
class TestClass(object):
82-
83-
@pytest.mark.dependency()
84-
def test_a():
85-
pass
86-
87-
@pytest.mark.dependency(depends=["TestClass::test_a"])
88-
def test_b():
89-
pass
90-
91-
If you override the test name in the pytest.mark.dependency()
92-
marker, nothing need to be changed.
93-
94-
Bug fixes and minor changes
95-
+ `#11`_: show the name of the skipped test.
96-
(Thanks asteriogonzalez!)
97-
+ `#13`_: Do not import pytest in setup.py to make it
98-
compatible with pipenv.
99-
+ `#15`_: tests fail with pytest 3.3.0.
100-
+ `#8`_: document incompatibility with parallelization in
101-
pytest-xdist.
102-
+ Clarify in the documentation that Python 3.1 is not officially
103-
supported because pytest 2.8 does not support it. There is no
104-
known issue with Python 3.1 though.
105-
106-
.. _#6: https://github.com/RKrahl/pytest-dependency/issues/6
107-
.. _#7: https://github.com/RKrahl/pytest-dependency/issues/7
108-
.. _#8: https://github.com/RKrahl/pytest-dependency/issues/8
109-
.. _#10: https://github.com/RKrahl/pytest-dependency/issues/10
110-
.. _#11: https://github.com/RKrahl/pytest-dependency/pull/11
111-
.. _#13: https://github.com/RKrahl/pytest-dependency/issues/13
112-
.. _#15: https://github.com/RKrahl/pytest-dependency/issues/15
113-
114-
0.2 (2017-05-28)
115-
New features
116-
+ `#2`_: Add documentation.
117-
+ `#4`_: Add a depend() function to add a dependency to a
118-
test at runtime.
119-
120-
.. _#2: https://github.com/RKrahl/pytest-dependency/issues/2
121-
.. _#4: https://github.com/RKrahl/pytest-dependency/issues/4
122-
123-
0.1 (2017-01-29)
124-
+ Initial release as an independent Python module.
125-
126-
This code was first developed as part of a larger package,
127-
python-icat, at Helmholtz-Zentrum Berlin für Materialien und
128-
Energie, see
129-
https://icatproject.org/user-documentation/python-icat/
1+
.. include:: ../../CHANGES.rst

0 commit comments

Comments
 (0)