Skip to content

Commit

Permalink
Release v3.0.0 (#290)
Browse files Browse the repository at this point in the history
  • Loading branch information
BeyondEvil authored Mar 28, 2022
1 parent 7371e52 commit 8e0a5d5
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 67 deletions.
84 changes: 19 additions & 65 deletions docs/development.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
Development
===========

To contribute to `pytest-selenium` you can use `Pipenv`_ to manage
To contribute to `pytest-selenium` you can use `Poetry <https://python-poetry.org/>`_ to manage
a python virtual environment and `pre-commit <https://pre-commit.com/>`_ to help you with
styling and formatting.

To setup the virtual environment and pre-commit, run:

.. code-block:: bash
$ pipenv install --dev
$ pipenv run pre-commit install
$ poetry install
$ poetry run pre-commit install
If you're not using `Pipenv`_, to install `pre-commit`, run:
If you're not using ``Poetry``, to install ``pre-commit``, run:

.. code-block:: bash
Expand All @@ -23,30 +23,21 @@ If you're not using `Pipenv`_, to install `pre-commit`, run:
Automated Testing
-----------------

All pull requests and merges are tested in `Travis CI <https://travis-ci.org/>`_
based on the ``.travis.yml`` file.

Usually, a link to your specific travis build appears in pull requests, but if
not, you can find it on the
`pull requests page <https://travis-ci.org/pytest-dev/pytest-selenium/pull_requests>`_

The only way to trigger Travis CI to run again for a pull request, is to submit
another change to the pull branch.

You can do this with `git commit --allow-empty`
All pull requests and merges are tested in `GitHub Actions <https://docs.github.com/en/actions>`_
based on the workflows defined in ``.github/workflows``.

Running Tests
-------------

You will need `Tox <http://tox.testrun.org/>`_ installed to run the tests
against the supported Python versions. If you're using `Pipenv`_ it will be
You will need `Tox <https://tox.wiki/en/latest/>`_ installed to run the tests
against the supported Python versions. If you're using ``Poetry`` it will be
installed for you.

With `Pipenv`_, run:
With ``Poetry``, run:

.. code-block:: bash
$ pipenv run tox
$ poetry run tox
Otherwise, to install and run, do:

Expand All @@ -55,54 +46,17 @@ Otherwise, to install and run, do:
$ pip install tox
$ tox
Drivers
-------
To run the tests you're going to need some browser drivers.

Chromedriver
~~~~~~~~~~~~
To install the latest `chromedriver <https://sites.google.com/a/chromium.org/chromedriver/>`_
on your Mac or Linux (64-bit), run:

.. code-block:: bash
$ ./installation/chromedriver.sh
For Windows users, please see `here <https://sites.google.com/a/chromium.org/chromedriver/getting-started>`_.

Geckodriver
~~~~~~~~~~~
To install the latest `geckodriver <https://firefox-source-docs.mozilla.org/testing/geckodriver/>`_
on your Mac or Linux (64-bit), run:

.. code-block:: bash
$ ./installation/geckodriver.sh
Safaridriver
~~~~~~~~~~~~
Instructions for `safaridriver <https://developer.apple.com/documentation/webkit/testing_with_webdriver_in_safari?language=objc>`_.

Edgedriver
~~~~~~~~~~
Instructions for `edgedriver <https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/#downloads>`_.

IEDriver
~~~~~~~~
Instructions for `iedriver <https://github.com/SeleniumHQ/selenium/wiki/InternetExplorerDriver>`_.

Releasing a new version
-----------------------

Follow these steps to release a new version of the project:

1. Update your local master with the upstream master (``git pull --rebase upstream master``)
2. Create a new branch and update ``news.rst`` with the new version, today's date, and all changes/new features
3. Commit and push the new branch and then create a new pull request
4. Wait for tests and reviews and then merge the branch
5. Once merged, update your local master again (``git pull --rebase upstream master``)
6. Tag the release with the new release version (``git tag v<new tag>``)
7. Push the tag (``git push upstream --tags``)
8. Done. You can monitor the progress on `Travis <https://travis-ci.org/pytest-dev/pytest-selenium/>`_

.. _Pipenv: https://docs.pipenv.org/en/latest/
#. Update your local master with the upstream master (``git pull --rebase upstream master``)
#. Create a new branch and update ``CHANGES.rst`` with the new version, today's date, and all changes/new features
#. Update ``pyproject.toml`` with the new version
#. Commit and push the new branch and then create a new pull request
#. Wait for tests and reviews and then merge the branch
#. Once merged, update your local master again (``git pull --rebase upstream master``)
#. Tag the release with the new release version (``git tag v<new tag>``)
#. Push the tag (``git push upstream --tags``)
#. Done.
10 changes: 10 additions & 0 deletions docs/news.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
Release Notes
=============

3.0.0 (2022-03-28)
------------------

* Switch project fully to pyproject.toml and Poetry

* Thanks to `@nfk <https://github.com/nfk>`_, `@dosas <https://github.com/dosas>`_,
`@lordgordon <https://github.com/lordgordon>`_, `@betterjblock <https://github.com/betterjblock>`_,
`@joshmgrant <https://github.com/joshmgrant>`_, `@rohitanand1614 <https://github.com/rohitanand1614>`_, and
`@kianmeng <https://github.com/kianmeng>`_ for all of their contributions to this release

2.0.1 (2020-09-19)
------------------

Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"

[tool.poetry]
name = "pytest-selenium"
version = "2.0.2rc0"
version = "3.0.0"
description = "pytest plugin for Selenium"
license = "MPL-2.0"
authors = [
Expand Down Expand Up @@ -45,7 +45,7 @@ include = [
python = "^3.6.2"
pytest = "^6.0.0"
pytest-base-url = "^1.4.2"
pytest-html = "^1.14.0"
pytest-html = ">=1.14.0"
pytest-variables = "^1.5.0"
requests = "^2.26.0"
selenium = "3.*"
Expand Down

0 comments on commit 8e0a5d5

Please sign in to comment.