Skip to content

Commit 7d867ce

Browse files
committed
Release notes for 3.1.0a2
1 parent c854eac commit 7d867ce

File tree

1 file changed

+140
-0
lines changed

1 file changed

+140
-0
lines changed

docs/SeleniumLibrary-3.1.0a2.rst

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

0 commit comments

Comments
 (0)