Skip to content

Move the changelog to read the docs #423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 18, 2020
Merged

Move the changelog to read the docs #423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
45fa6e6
Move the changelog to read the docs
gnikonorov Dec 15, 2020
01aaa32
Merge branch 'master' into move_changelog_to_rtd
gnikonorov Dec 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ repos:
- id: rst
name: rst
entry: rst-lint --encoding utf-8
files: ^(CHANGES.rst|development.rst|README.rst)$
files: ^(README.rst)$
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't we want to lint the removed rst-files?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't we want to lint the removed rst-files?

We do, and RTD does lint for us. This lint is for files under the project root though and so should be removed since we're asking for it to lint file that no longer exist

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it, thanks! 👍

Can we still lint on commit somehow? So that you don't have to wait for RTD to do it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd need to double check @BeyondEvil ( I think so ) but regardless of whether we do or not this line achieves nothing and should be removed since the files no longer exist.

I made a note to double check linting

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We also have a tox command to build documentation and it runs in GHA on all PRs, so we definitely don't need to wait on upload to RTD for feedback @BeyondEvil

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, sphinx, so can I assume sphinx will catch linting issues then? @gnikonorov

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, sphinx, so can I assume sphinx will catch linting issues then? @gnikonorov

I think so. I made a note to double check this.

We also can't use this linter since the RST syntax is different ( I remember trying to use it and having it fail in the original doc migration )

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opened an issue to investigate linting RTD @BeyondEvil (#428). Can you please review this change? I'd like to get it merged if there are no objections on your end. I'll tackle any linting requirements ( if needed ) in a follow up PR

language: python
additional_dependencies: [pygments, restructuredtext_lint]
- repo: https://github.com/elidupuis/mirrors-sass-lint
Expand Down
2 changes: 1 addition & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Resources
---------

- `Documentation <https://pytest-html.readthedocs.io/en/latest/>`_
- `Release Notes <http://github.com/pytest-dev/pytest-html/blob/master/CHANGES.rst>`_
- `Release Notes <https://pytest-html.readthedocs.io/en/latest/changelog.html>`_
- `Issue Tracker <http://github.com/pytest-dev/pytest-html/issues>`_
- `Code <http://github.com/pytest-dev/pytest-html/>`_

Expand Down
140 changes: 95 additions & 45 deletions CHANGES.rst → docs/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,27 @@
Release Notes
-------------
Changelog
=========

**3.2.0 (unreleased)**
Versions follow `Semantic Versioning`_ (``<major>.<minor>.<patch>``).

Version History
---------------

3.2.0 (unreleased)
~~~~~~~~~~~~~~~~~~

* Make the report tab title reflect the report name. (`#412 <https://github.com/pytest-dev/pytest-html/issues/412>`_)

* Thanks to `@gnikonorov <https://github.com/gnikonorov>`_ for the PR

**3.1.1 (2020-12-13)**
3.1.1 (2020-12-13)
~~~~~~~~~~~~~~~~~~

* Fix issue with reporting of missing CSS files. (`#388 <https://github.com/pytest-dev/pytest-html/issues/388>`_)

* Thanks to `@prakhargurunani <https://github.com/prakhargurunani>`_ for reporting and fixing!

**3.1.0 (2020-12-2)**
3.1.0 (2020-12-2)
~~~~~~~~~~~~~~~~~

* Stop attaching test reruns to final test report entries (`#374 <https://github.com/pytest-dev/pytest-html/issues/374>`_)

Expand All @@ -23,7 +31,8 @@ Release Notes

* Thanks to `@brettnolan <https://github.com/brettnolan>`_ for reporting and `@gnikonorov <https://github.com/gnikonorov>`_ for the fix

**3.0.0 (2020-10-28)**
3.0.0 (2020-10-28)
~~~~~~~~~~~~~~~~~~

* Respect ``--capture=no``, ``--show-capture=no``, and ``-s`` pytest flags (`#171 <https://github.com/pytest-dev/pytest-html/issues/171>`_)

Expand All @@ -45,13 +54,15 @@ Release Notes

* Thanks to `@iwanb <https://github.com/iwanb>`_ for reporting and `@csm10495 <https://github.com/csm10495>`_ for the fix

**2.1.1 (2020-03-18)**
2.1.1 (2020-03-18)
~~~~~~~~~~~~~~~~~~

* Fix issue with funcargs causing failures. (`#282 <https://github.com/pytest-dev/pytest-html/issues/282>`_)

* Thanks to `@ssbarnea <https://github.com/ssbarnea>`_ for reporting and `@christiansandberg <https://github.com/christiansandberg>`_ for the fix

**2.1.0 (2020-03-09)**
2.1.0 (2020-03-09)
~~~~~~~~~~~~~~~~~~

* Added support for MP4 video format. (`#260 <https://github.com/pytest-dev/pytest-html/pull/260>`_)

Expand All @@ -73,7 +84,8 @@ Release Notes

* Thanks to `@werdeil <https://github.com/werdeil>`_ for the PR

**2.0.1 (2019-10-05)**
2.0.1 (2019-10-05)
~~~~~~~~~~~~~~~~~~

* Properly check for presence of CSS file. (`#246 <https://github.com/pytest-dev/pytest-html/issues/246>`_)

Expand All @@ -87,13 +99,15 @@ Release Notes

* Thanks to `@wanam <https://github.com/wanam>`_ for reporting and fixing

**2.0.0 (2019-09-09)**
2.0.0 (2019-09-09)
~~~~~~~~~~~~~~~~~~

* Drop support for Python 2.7. We will continue to accept patches to ``1.22.x`` for the time being.

* Thanks to `@hugovk <https://github.com/hugovk>`_ for the PR

**1.22.0 (2019-08-06)**
1.22.0 (2019-08-06)
~~~~~~~~~~~~~~~~~~~

* Refactor assets naming to be more readable and OS safe.

Expand All @@ -105,21 +119,24 @@ Release Notes

* Thanks to `@borntyping <https://github.com/borntyping>`_ for reporting and fixing!

**1.21.1 (2019-06-19)**
1.21.1 (2019-06-19)
~~~~~~~~~~~~~~~~~~~

* Fix issue with assets filenames being too long.

* Thanks to `@D3X <https://github.com/D3X>`_ for reporting and providing a fix

**1.21.0 (2019-06-17)**
1.21.0 (2019-06-17)
~~~~~~~~~~~~~~~~~~~

* Allow opening generated html report in browser (`@ssbarnea <https://github.com/ssbarnea>`_)

* Handle when report title is stored as an environment variable (`@BeyondEvil <https://github.com/BeyondEvil>`_)

* Change assets naming method (`@SunInJuly <https://github.com/SunInJuly>`_)

**1.20.0 (2019-01-14)**
1.20.0 (2019-01-14)
~~~~~~~~~~~~~~~~~~~

* Tests running with Pytest 4.0 and Python 3.7

Expand All @@ -134,22 +151,25 @@ Release Notes

* Refactor css config code (`@crazymerlyn <http://github.com/crazymerlyn>`_)

**1.19.0 (2018-06-01)**
1.19.0 (2018-06-01)
~~~~~~~~~~~~~~~~~~~

* Allow collapsed outcomes to be configured by using a query parameter

* Thanks to `@Formartha <https://github.com/Formartha>`_ for suggesting this
enhancement and to `@jacebrowning <https://github.com/jacebrowning>`_ for
providing a patch

**1.18.0 (2018-05-22)**
1.18.0 (2018-05-22)
~~~~~~~~~~~~~~~~~~~

* Preserve the order if metadata is ``OrderedDict``

* Thanks to `@jacebrowning <https://github.com/jacebrowning>`_ for suggesting
this enhancement and providing a patch

**1.17.0 (2018-04-05)**
1.17.0 (2018-04-05)
~~~~~~~~~~~~~~~~~~~

* Add support for custom CSS (`#116 <https://github.com/pytest-dev/pytest-html/issues/116>`_)

Expand All @@ -173,7 +193,8 @@ Release Notes
* Thanks to `@j19sch <https://github.com/j19sch>`_ for the PR


**1.16.1 (2018-01-04)**
1.16.1 (2018-01-04)
~~~~~~~~~~~~~~~~~~~

* Fix for including screenshots on Windows
(`#124 <https://github.com/pytest-dev/pytest-html/issues/124>`_)
Expand All @@ -182,27 +203,31 @@ Release Notes
issue and to `@pinkie1378 <https://github.com/pinkie1378>`_ for providing a
fix

**1.16.0 (2017-09-19)**
1.16.0 (2017-09-19)
~~~~~~~~~~~~~~~~~~~

* Improve rendering of collections in metadata
(`@rasmuspeders1 <https://github.com/rasmuspeders1>`_)

**1.15.2 (2017-08-15)**
1.15.2 (2017-08-15)
~~~~~~~~~~~~~~~~~~~

* Always decode byte string in extra text

* Thanks to `@ch-t <https://github.com/ch-t>`_ for reporting the issue and
providing a fix

**1.15.1 (2017-06-12)**
1.15.1 (2017-06-12)
~~~~~~~~~~~~~~~~~~~

* Fix pytest dependency to 3.0 or later

* Thanks to `@silvana-i <https://github.com/silvana-i>`_ for reporting the
issue and to `@nicoddemus <https://github.com/nicoddemus>`_ for providing a
fix

**1.15.0 (2017-06-09)**
1.15.0 (2017-06-09)
~~~~~~~~~~~~~~~~~~~

* Fix encoding issue in longrepr values

Expand All @@ -213,57 +238,66 @@ Release Notes

* Thanks to `@BeyondEvil <https://github.com/BeyondEvil>`_ for the PR

**1.14.2 (2017-03-10)**
1.14.2 (2017-03-10)
~~~~~~~~~~~~~~~~~~~

* Always encode content for data URI

* Thanks to `@micheletest <https://github.com/micheletest>`_ and
`@BeyondEvil <https://github.com/BeyondEvil>`_ for reporting the issue and
confirming the fix

**1.14.1 (2017-02-28)**
1.14.1 (2017-02-28)
~~~~~~~~~~~~~~~~~~~

* Present metadata without additional formatting to avoid issues due to
unpredictable content types

**1.14.0 (2017-02-27)**
1.14.0 (2017-02-27)
~~~~~~~~~~~~~~~~~~~

* Add hooks for modifying the test results table
* Replace environment section with values from
`pytest-metadata <https://pypi.python.org/pypi/pytest-metadata/>`_
* Fix encoding for asset files
* Escape contents of log sections

**1.13.0 (2016-12-19)**
1.13.0 (2016-12-19)
~~~~~~~~~~~~~~~~~~~

* Disable ANSI codes support by default due to dependency on
`ansi2html <https://pypi.python.org/pypi/ansi2html/>`_ package with less
permissive licensing

**1.12.0 (2016-11-30)**
1.12.0 (2016-11-30)
~~~~~~~~~~~~~~~~~~~

* Add support for JPG and SVG images
(`@bhzunami <https://github.com/bhzunami>`_)
* Add version number and PyPI link to report header
(`@denisra <https://github.com/denisra>`_)

**1.11.1 (2016-11-25)**
1.11.1 (2016-11-25)
~~~~~~~~~~~~~~~~~~~

* Fix title of checkbox disappearing when unchecked
(`@vashirov <https://github.com/vashirov>`_)

**1.11.0 (2016-11-08)**
1.11.0 (2016-11-08)
~~~~~~~~~~~~~~~~~~~

* Add support for ANSI codes in logs
(`@premkarat <https://github.com/premkarat>`_)

**1.10.1 (2016-09-23)**
1.10.1 (2016-09-23)
~~~~~~~~~~~~~~~~~~~

* Fix corrupt image asset files
* Remove image links from self-contained report
* Fix issue with unexpected passes not being reported in pytest 3.0

**1.10.0 (2016-08-09)**
1.10.0 (2016-08-09)
~~~~~~~~~~~~~~~~~~~

* Hide filter checkboxes when JavaScript is disabled
(`@RibeiroAna <https://github.com/RibeiroAna>`_)
Expand All @@ -280,7 +314,8 @@ Release Notes
* Allow visibility of extra details to be toggled
(`@leitzler <https://github.com/leitzler>`_)

**1.9.0 (2016-07-04)**
1.9.0 (2016-07-04)
~~~~~~~~~~~~~~~~~~

* Split pytest_sessionfinish into generate and save methods
(`@karandesai-96 <https://github.com/karandesai-96>`_)
Expand All @@ -289,63 +324,78 @@ Release Notes
* Added a feature to filter tests by outcome
(`@RibeiroAna <https://github.com/RibeiroAna>`_)

**1.8.1 (2016-05-24)**
1.8.1 (2016-05-24)
~~~~~~~~~~~~~~~~~~

* Include captured output for passing tests

**1.8.0 (2016-02-24)**
1.8.0 (2016-02-24)
~~~~~~~~~~~~~~~~~~

* Remove duplication from the environment section
* Dropped support for Python 3.2
* Indicated setup and teardown in report
* Fixed colour of errors in report

**1.7 (2015-10-19)**
1.7 (2015-10-19)
~~~~~~~~~~~~~~~~

* Fixed INTERNALERROR when an xdist worker crashes
(`@The-Compiler <https://github.com/The-Compiler>`_)
* Added report sections including stdout and stderr to log

**1.6 (2015-09-08)**
1.6 (2015-09-08)
~~~~~~~~~~~~~~~~

* Fixed environment details when using pytest-xdist

**1.5.1 (2015-08-18)**
1.5.1 (2015-08-18)
~~~~~~~~~~~~~~~~~~

* Made environment fixture session scoped to avoid repeating content

**1.5 (2015-08-18)**
1.5 (2015-08-18)
~~~~~~~~~~~~~~~~

* Replaced custom hook for setting environemnt section with a fixture

**1.4 (2015-08-12)**
1.4 (2015-08-12)
~~~~~~~~~~~~~~~~

* Dropped support for pytest 2.6
* Fixed unencodable strings for Python 3
(`@The-Compiler <https://github.com/The-Compiler>`_)

**1.3.2 (2015-07-27)**
1.3.2 (2015-07-27)
~~~~~~~~~~~~~~~~~~

* Prevented additional row if log has no content or there is no extra HTML

**1.3.1 (2015-05-26)**
1.3.1 (2015-05-26)
~~~~~~~~~~~~~~~~~~

* Fixed encoding issue in Python 3

**1.3 (2015-05-26)**
1.3 (2015-05-26)
~~~~~~~~~~~~~~~~

* Show extra content regardless of test result
* Added support for extra content in JSON format

**1.2 (2015-05-20)**
1.2 (2015-05-20)
~~~~~~~~~~~~~~~~

* Changed default sort order to test result
(`@The-Compiler <https://github.com/The-Compiler>`_)

**1.1 (2015-05-08)**
1.1 (2015-05-08)
~~~~~~~~~~~~~~~~

* Added Python 3 support

**1.0 (2015-04-20)**
1.0 (2015-04-20)
~~~~~~~~~~~~~~~~

* Initial release

.. _Semantic Versioning: https://semver.org
Loading