test_ok2/changelog
Bruno Oliveira ff7b5dbbde
Merge pull request #6784 from nicoddemus/deprecate-terminal-writer
Deprecate TerminalReporter.writer
2020-02-28 21:07:02 -03:00
..
310.bugfix.rst doctest: handle any OutcomeException (#6669) 2020-02-19 13:16:37 +01:00
449.improvement.rst terminal: use "yellow" with any "xpassed" tests 2020-01-09 22:20:41 +01:00
759.improvement.rst parametrized: ids: support generator/iterator 2019-11-20 19:02:17 +01:00
1857.improvement.rst parametrized: ids: support generator/iterator 2019-11-20 19:02:17 +01:00
3238.deprecation.rst Deprecate --no-print-logs option 2019-12-14 16:46:30 -08:00
3823.bugfix.rst unittest: do not use TestCase.debug() with `--pdb` 2019-11-10 00:21:51 +01:00
4445.bugfix.rst Add stacklevel tests for warnings, 'location' to pytest_warning_captured 2019-11-22 17:50:00 -03:00
4597.feature.rst Include new --capture-mode=tee-sys option 2019-12-09 13:05:23 -03:00
4639.improvement.rst Preparing release version 5.3.2 2019-12-13 08:51:15 -03:00
5301.bugfix.rst LFPlugin: use sub-plugins to deselect during collection (#6448) 2020-02-19 21:33:03 +01:00
5686.improvement.rst fix #5686, mktemp now fails given absolute and non-normalized paths. 2019-12-12 13:00:23 +01:00
5712.feature.rst [parametrize] enforce explicit argnames declaration (#6330) 2020-02-06 20:20:25 -03:00
5928.bugfix.rst Add stacklevel tests for warnings, 'location' to pytest_warning_captured 2019-11-22 17:50:00 -03:00
5975.deprecation.rst fix #6341 - disallow session/config in Node.from_parent 2020-01-15 13:00:46 +01:00
5984.improvement.rst Add stacklevel tests for warnings, 'location' to pytest_warning_captured 2019-11-22 17:50:00 -03:00
5991.bugfix.rst unittest: do not use TestCase.debug() with `--pdb` 2019-11-10 00:21:51 +01:00
6213.improvement.rst pytester: remove special handling of env during inner runs 2019-11-22 21:50:31 +01:00
6247.improvement.rst Respect --fulltrace with collection errors 2019-11-20 23:35:33 +01:00
6316.breaking.rst Replace 'removal' by 'breaking' changelog category 2019-12-06 08:50:35 -03:00
6334.bugfix.rst Add CHANGELOG entry for #6334 2019-12-12 08:05:22 -03:00
6384.improvement.rst Make --showlocals work together with --tb=short 2020-01-14 21:30:58 +02:00
6404.trivial.rst Remove usage of parser module, deprecated in Python 3.9 2020-01-06 08:57:07 -03:00
6409.bugfix.rst _get_main_color: no yellow ("boring") for non-last item 2020-01-25 15:09:02 +01:00
6443.breaking.rst pluginmanager.consider_preparse: add exclude_only kwarg (#6443) 2020-02-03 14:10:54 +01:00
6454.bugfix.rst terminal: default to `fE` with `-r` (reportchars) 2020-01-29 00:33:15 +01:00
6454.feature.rst terminal: default to `fE` with `-r` (reportchars) 2020-01-29 00:33:15 +01:00
6469.feature.rst Improve CHANGELOG and docs for junit_logging 2020-01-16 07:47:00 -03:00
6497.bugfix.rst Replace `==` with `is` for comparison of cache keys 2020-01-28 18:05:53 -03:00
6557.bugfix.rst Fix EncodedFile.write return value 2020-01-25 10:36:23 +01:00
6566.bugfix.rst Fix `EncodedFile.writelines` 2020-01-25 18:06:50 +01:00
6575.bugfix.rst Fix crash when faulthandler starts initialized (#6598) 2020-02-12 11:06:20 +01:00
6597.bugfix.rst Fix node ids which contain a parametrized empty-string variable 2020-01-28 13:27:54 -08:00
6637.breaking.rst Remove deprecated 'pytest_itemstart' hook 2020-01-30 21:03:29 -03:00
6646.bugfix.rst assertion: save/restore hooks on item (#6646) 2020-02-04 02:56:23 +01:00
6653.improvement.rst pytester.LineMatcher: add support for matching lines consecutively 2020-02-01 23:48:58 +01:00
6658.improvement.rst Use code highlighting if pygments is installed (#6658) 2020-02-12 08:32:37 -03:00
6660.bugfix.rst Handle `Exit` exception in `pytest_sessionfinish` 2020-02-02 23:13:23 +01:00
6673.breaking.rst Reverse / fix meaning of "+/-" in error diffs 2020-02-10 21:12:37 +01:00
6696.doc.rst doc: add list of fixtures to start of fixture chapter (#6696) 2020-02-22 14:56:19 +01:00
6737.breaking.rst Fix grammar in changelog/6737.breaking.rst 2020-02-22 13:15:17 +01:00
6742.doc.rst doc: expand first sentence on fixtures into a paragraph (#6742) 2020-02-15 18:35:36 +01:00
6752.bugfix.rst Handle `match` with `pytest.raises()` (#6753) 2020-02-22 23:32:55 +01:00
6779.deprecation.rst Deprecate TerminalReporter.writer 2020-02-20 21:04:49 -03:00
6795.improvement.rst Improve UsageError with invalid `-o` style (#6795) 2020-02-28 19:41:56 +01:00
6801.bugfix.rst doctest: strip newlines with unexpected exceptions (#6801) 2020-02-24 15:18:08 +01:00
README.rst docs: use doc/en/_build/html for html output (#6842) 2020-02-29 00:47:30 +01:00
_template.rst Update CHANGELOG template to put issue links at the start of entries 2018-07-07 11:02:33 -03:00

README.rst

This directory contains "newsfragments" which are short files that contain a small **ReST**-formatted
text that will be added to the next ``CHANGELOG``.

The ``CHANGELOG`` will be read by **users**, so this description should be aimed to pytest users
instead of describing internal changes which are only relevant to the developers.

Make sure to use full sentences in the **past or present tense** and use punctuation, examples::

    Improved verbose diff output with sequences.

    Terminal summary statistics now use multiple colors.

Each file should be named like ``<ISSUE>.<TYPE>.rst``, where
``<ISSUE>`` is an issue number, and ``<TYPE>`` is one of:

* ``feature``: new user facing features, like new command-line options and new behavior.
* ``improvement``: improvement of existing functionality, usually without requiring user intervention (for example, new fields being written in ``--junitxml``, improved colors in terminal, etc).
* ``bugfix``: fixes a bug.
* ``doc``: documentation improvement, like rewording an entire session or adding missing docs.
* ``deprecation``: feature deprecation.
* ``breaking``: a change which may break existing suites, such as feature removal or behavior change.
* ``vendor``: changes in packages vendored in pytest.
* ``trivial``: fixing a small typo or internal change that might be noteworthy.

So for example: ``123.feature.rst``, ``456.bugfix.rst``.

If your PR fixes an issue, use that number here. If there is no issue,
then after you submit the PR and get the PR number you can add a
changelog using that instead.

If you are not sure what issue type to use, don't hesitate to ask in your PR.

``towncrier`` preserves multiple paragraphs and formatting (code blocks, lists, and so on), but for entries
other than ``features`` it is usually better to stick to a single paragraph to keep it concise.

You can also run ``tox -e docs`` to build the documentation
with the draft changelog (``doc/en/_build/html/changelog.html``) if you want to get a preview of how your change will look in the final release notes.