Skip to content

Commit a64fd82

Browse files
aaltataaltat
committed
Release notes for 3.1.0
1 parent d60cb7f commit a64fd82

1 file changed

Lines changed: 126 additions & 0 deletions

File tree

‎docs/SeleniumLibrary-3.1.0.rst‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
=====================
2+
SeleniumLibrary 3.1.0
3+
=====================
4+
5+
6+
.. default-role:: code
7+
8+
9+
SeleniumLibrary_ is a web testing library for `Robot Framework`_ that utilizes
10+
the Selenium_ tool internally. SeleniumLibrary 3.1.0 is a new pre release with
11+
support for headless Chrome and Firefox and and allows to pass desired capabilities
12+
to local browsers also when using `Open Browser` keyword.
13+
14+
If you have pip_ installed, just run
15+
16+
::
17+
18+
pip install --upgrade robotframework-seleniumlibrary
19+
20+
to install the latest available release or use
21+
22+
::
23+
24+
pip install robotframework-seleniumlibrary==3.1.0
25+
26+
to install exactly this version. Alternatively you can download the source
27+
distribution from PyPI_ and install it manually.
28+
29+
SeleniumLibrary 3.1.0 was released on Thursday February 15, 2018.
30+
31+
.. _Robot Framework: http://robotframework.org
32+
.. _SeleniumLibrary: https://github.com/robotframework/SeleniumLibrary
33+
.. _Selenium: http://seleniumhq.org
34+
.. _pip: http://pip-installer.org
35+
.. _PyPI: https://pypi.python.org/pypi/robotframework-seleniumlibrary
36+
.. _issue tracker: https://github.com/robotframework/SeleniumLibrary/issues?q=milestone%3Av3.1.0
37+
38+
39+
.. contents::
40+
:depth: 2
41+
:local:
42+
43+
Most important enhancements
44+
===========================
45+
46+
Add option to start browser headless in Open Browser keyword (`#1014`_, alpha 1)
47+
--------------------------------------------------------------------------------
48+
The `Open Browser` keyword supports starting Chrome and Firefox browsers in headless
49+
mode. This can done be setting the `browser` argument to `headlessfirefox` or
50+
`headlesschrome` values. Using the headless mode requires Selenium 3.8.0 or greater.
51+
52+
Backwards incompatible changes
53+
==============================
54+
55+
Allow Open Browser keyword to pass capabilities also for local browsers (`#550`_, alpha 1)
56+
------------------------------------------------------------------------------------------
57+
The `Open Browser` keyword `desired_capabilities` argument can now be used to configure
58+
a browser when starting a local browser. In the previous releases, the `desired_capabilities`
59+
argument was used only when the `remote_url` argument was provided. Now this now is changed
60+
and `desired_capabilities` argument can be also used to configure browser running locally.
61+
62+
Remove deprecated browser attribute from the library public API. (`#1036`_, alpha 1)
63+
-------------------------------------------------------------------------------------
64+
During the 3.0.0 prerelease phase, we did changed some of the public API arguments names.
65+
But we wanted to provide backwards support for the early adopters by keeping some of the
66+
old public API attributes in place. This attribute was deprecated during prereleases and it
67+
should have been removed during the 3.0.0 final release, but that was forgotten.
68+
The `browser` public API attribute is now removed in this release.
69+
70+
71+
Acknowledgements
72+
================
73+
74+
Many thanks to rubygeek for adding a `message` param to `Title Should Be` keyword to display
75+
custom error message.
76+
77+
Many thanks to rubygeek, for providing the PR for the ignore case enhancement.
78+
79+
Full list of fixes and enhancements
80+
===================================
81+
82+
.. list-table::
83+
:header-rows: 1
84+
85+
* - ID
86+
- Type
87+
- Priority
88+
- Summary
89+
* - `#1014`_
90+
- enhancement
91+
- critical
92+
- Add option to start browser headless in Open Browser keyword
93+
* - `#1007`_
94+
- enhancement
95+
- high
96+
- Document how to extend the library
97+
* - `#1042`_
98+
- enhancement
99+
- medium
100+
- Add Message attribute to the Page Title Should Be function
101+
* - `#550`_
102+
- enhancement
103+
- medium
104+
- Allow Open Browser keyword to pass capabilities also for local browsers
105+
* - `#849`_
106+
- enhancement
107+
- medium
108+
- Verify string regardless of case
109+
* - `#1036`_
110+
- enhancement
111+
- low
112+
- Remove deprecated browser attribute from the library public API.
113+
* - `#1040`_
114+
- enhancement
115+
- low
116+
- Move WebDriverCache and WebDriverCreator under same module
117+
118+
Altogether 7 issues. View on the `issue tracker <https://github.com/robotframework/SeleniumLibrary/issues?q=milestone%3Av3.1.0>`__.
119+
120+
.. _#1014: https://github.com/robotframework/SeleniumLibrary/issues/1014
121+
.. _#1007: https://github.com/robotframework/SeleniumLibrary/issues/1007
122+
.. _#1042: https://github.com/robotframework/SeleniumLibrary/issues/1042
123+
.. _#550: https://github.com/robotframework/SeleniumLibrary/issues/550
124+
.. _#849: https://github.com/robotframework/SeleniumLibrary/issues/849
125+
.. _#1036: https://github.com/robotframework/SeleniumLibrary/issues/1036
126+
.. _#1040: https://github.com/robotframework/SeleniumLibrary/issues/1040

0 commit comments

Comments
 (0)