Skip to content

Commit 10308bb

Browse files
HelioGuilherme66HelioGuilherme66
committed
Version 2.1b1
1 parent 28276ac commit 10308bb

File tree

1 file changed

+284
-0
lines changed

1 file changed

+284
-0
lines changed

‎doc/releasenotes/ride-2.1b1.rst‎

Lines changed: 284 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,284 @@
1+
.. container:: document
2+
3+
`RIDE (Robot Framework
4+
IDE) <https://github.com/robotframework/RIDE/>`__ v2.1b1 is a new
5+
release with important enhancements and bug fixes. The reference for
6+
valid arguments is `Robot Framework <https://robotframework.org/>`__
7+
installed version, which is at this moment 7.1. However, internal
8+
library code is originally based on version 3.1.2, but adapted for
9+
new versions.
10+
11+
- This version supports Python 3.8 up to 3.12.
12+
- There are some changes, or known issues:
13+
14+
- ❌ - Removed support for Python 3.6 and 3.7
15+
- ✔ - Fixed on Text Editor when Saving the selection of tests to
16+
run in Test Suites (Tree) is cleared.
17+
- ✔ - Added Korean language support for UI.
18+
- ✔ - Added **caret style** to change insert caret to 'block' or
19+
'line' in Text Editor, by editing *settings.cfg*. The color of
20+
the caret is the same as 'setting' and will be adjusted for
21+
better contrast with the background.
22+
- ✔ - Allow to do auto-suggestions of keywords in Text Editor
23+
without a shortcut, if you want to enable or disable this
24+
feature you can config in \`Tools -> Preferences -> Text Editor
25+
-> Enable auto suggestions\`.
26+
- ✔ - Added support for Setup in keywords, since Robot Framework
27+
version 7.0.
28+
- ✔ - Added support for new VAR marker, since Robot Framework
29+
version 7.0.
30+
- ✔ - Added to Grid Editor changing Zoom In/Out with **Ctrl-Mouse
31+
Wheel** and setting at Preferences.
32+
- ✔ - Fixed plugin Run Anything (Macros) not showing output and
33+
broken actions.
34+
- ✔ - Added actions on columns of Grid Editor: Double-Click or
35+
Right Mouse Click, allows to edit the column name for Data
36+
Driven or Templated; Left Mouse Click, selects the column
37+
cells.
38+
- ✔ - Added command line option, **--settingspath**, to select a
39+
different configuration.
40+
- ✔ - Added different settings file, according the actual Python
41+
executable, if not the original installed.
42+
- ✔ - Added a selector for Tasks and Language to the New Project
43+
dialog.
44+
- ✔ - Added UI localization prepared for all the languages from
45+
installed Robot Framework version 6.1, or higher. Major
46+
translations are: Dutch, Portuguese and Brazilian Portuguese.
47+
Still missing translation of some elements.
48+
- ✔ - Added support for language configured test suites, with
49+
languages from installed Robot Framework version 6.1, or
50+
higher.
51+
- ✔ - On Text Editor, pressing **Ctrl** when the caret/cursor is
52+
near a Keyword will show a detachable window with the
53+
documentation, at Mouse Pointer position.
54+
- ✔ - RIDE tray icon now shows a context menu with options Show,
55+
Hide and Close.
56+
- ✔ - Highlighting and navigation of selected Project Explorer
57+
items, in Text Editor.
58+
- ✔ - When editing in Grid Editor with content assistance, the
59+
selected content can be edited by escaping the list of
60+
suggestions with keys ARROW_LEFT or ARROW_RIGHT.
61+
- ✔ - Newlines in Grid Editor can be made visible with the
62+
**filter newlines** set to False.
63+
- 🐞 - Problems with COPY/PASTE in Text Editor have been reported
64+
when using wxPython 4.2.0, but not with version 4.2.1 and
65+
4.2.2, which we now *recommend*.
66+
- 🐞 - Some argument types detection (and colorization) is not
67+
correct in Grid Editor.
68+
- 🐞 - RIDE **DOES NOT KEEP** Test Suites formatting or
69+
structure, causing differences in files when used on other IDE
70+
or Editors.
71+
72+
**New Features and Fixes Highlights**
73+
74+
- Fixed validation of multiple arguments with default values in Grid
75+
Editor.
76+
- Added color to Test Runner Console Log final output, report and
77+
log since RF v7.1rc1.
78+
- Fixed on Text Editor when Saving the selection of tests to run in
79+
Test Suites (Tree) is cleared.
80+
- Added Korean language support for UI, experimental.
81+
- Fixed wrong item selection, like Test Suite, when doing
82+
right-click actions in Project Explorer.
83+
- Fixed delete variable from Test Suite settings remaining in
84+
Project Explorer.
85+
- Added **caret style** to change insert caret to 'block' or 'line'
86+
in Text Editor, by editing *settings.cfg*. The color of the caret
87+
is the same as 'setting' and will be adjusted for better contrast
88+
with the background.
89+
- Fixed obsfuscation of Libraries and Metadata panels when expanding
90+
Settings in Grid Editor and Linux systems.
91+
- Allow to do auto-suggestions of keywords in Text Editor without a
92+
shortcut, if you want to enable or disable this feature you can
93+
config in \`Tools -> Preferences -> Text Editor -> Enable auto
94+
suggestions\`.
95+
- Added support for Setup in keywords, since Robot Framework version
96+
7.0.
97+
- Fixed multiline variables in Variables section. In Text Editor
98+
they are separated by ... continuation marker. In Grid Editor use
99+
\| (pipe) to separate lines.
100+
- Added support for new VAR marker, since Robot Framework version
101+
7.0.
102+
- Added configurable style of the tabs in notebook pages, Edit,
103+
Text, Run, etc. Parameter **notebook theme** takes values from 0
104+
to 5. See wxPython, demo for agw.aui for details.
105+
- Added UI localization and support for Japanese configured test
106+
suites, valid for Robot Framework version 7.0.1 or higher.
107+
- Fixed keywords Find Usages in Grid Editor not finding certain
108+
values when using Gherkin.
109+
- Improved selection of items from Tree in Text Editor. Now finds
110+
more items and selects whole line.
111+
- Changed output in plugin Run Anything (Macros) to allow Zoom
112+
In/Out, and Copy content.
113+
- Added to Grid Editor changing Zoom In/Out with **Ctrl-Mouse
114+
Wheel** and setting at Preferences.
115+
- Fixed plugin Run Anything (Macros) not showing output and broken
116+
actions.
117+
- Added actions on columns of Grid Editor: Double-Click or Right
118+
Mouse Click, allows to edit the column name for Data Driven or
119+
Templated; Left Mouse Click, selects the column cells.
120+
- Added command line option, **--settingspath**, to select a
121+
different configuration.
122+
- Added different settings file, according the actual Python
123+
executable, if not the original installed.
124+
- Fixed headers and blank spacing in Templated tests.
125+
- Added context option **Open Containing Folder** to test suites
126+
directories in Project Explorer.
127+
- Added a setting for a specific file manager by editing the
128+
settings.cfg file. Add the string parameter **file manager** in
129+
the section **[General]**
130+
- Added minimal support to have comment lines in Import settings.
131+
These are not supposed to be edited in Editor, and new lines are
132+
added at Text Editor.
133+
- Fixed removal of continuation marker in steps
134+
- Fixed wrong continuation of long chains of keywords in Setups,
135+
Teardowns or Documentation.
136+
- Added a selector for Tasks and Language to the New Project dialog.
137+
Still some problems: Tasks type changes to Tests, localized
138+
sections only stay translated after Apply in Text Editor.
139+
- Added UI localization prepared for all the languages from
140+
installed Robot Framework version 6.1, or higher. Language is
141+
selected from Tools->Preferences->General.
142+
- Removed support for HTML file format (obsolete since Robot
143+
Framework 3.2)
144+
- Added support for language configured test suites. Fields are
145+
shown in the language of the files in Grid Editor. Tooltips are
146+
always shown in English. Colorization for language configured
147+
files is working in Text Editor.
148+
- Fixed New User Keyword dialog not allowing empty Arguments field
149+
- Fixed escaped spaces showing in Text Editor on commented cells
150+
- Improved keywords documentation search, by adding current dir to
151+
search
152+
- Improved Move up/down, **Alt-UpArrow**/**Alt-DownArrow** in Text
153+
Editor, to have proper indentation and selection
154+
- Added auto update check when development version is installed
155+
- Added menu option **Help->Check for Upgrade** which allows to
156+
force update check and install development version
157+
- Added **Upgrade Now** action to update dialog.
158+
- Added **Test Tags** field (new, since Robot Framework 6.0) to Test
159+
Suites settings. This field will replace **Default** and **Force
160+
Tags** settings, after Robot Framework 7.0
161+
- Improved **RIDE Log** and **Parser Log** windows to allow Zoom
162+
In/Out with **Ctrl-Mouse Wheel**
163+
- Hide continuation markers in Project Tree
164+
- Improved content assistance in Text Editor by allowing to filter
165+
list as we type
166+
- Fixed resource files disappearing from Project tree on Windows
167+
- Fixed missing indication of link for User Keyword, when pressing
168+
**Ctrl** in Grid Editor
169+
- Added content help pop-up on Text Editor by pressing **Ctrl** for
170+
text at cursor position or selected autocomplete list item
171+
- Added Exclude option in context nenu for Test files, previously
172+
was only possible for Test Suites folders
173+
- Added exclusion of monitoring filesystem changes for files and
174+
directories excluded in Preferences
175+
- Fixed exception when finding GREY color for excluded files and
176+
directories in Project Tree
177+
- Added support for JSON variables, by using the installed Robot
178+
Framework import method
179+
- Colorization of Grid Editor cells after the continuation marker
180+
**...** and correct parsing of those lines
181+
- Colorization of Grid Editor cells when contents is list or
182+
dictionary variables
183+
- Added indication of matching brackets, **()**, **{}**, **[]**, in
184+
Text Editor
185+
- Fixed non synchronized expanding/collapse of Settings panel in
186+
Grid Editor, on Linux
187+
- Fixed not working the deletion of cells commented with **#** in
188+
Grid Editor with **Ctrl-Shift-D**
189+
- Fixed empty line being always added to the Variables section in
190+
Text Editor
191+
- Improved project file system changes and reloading
192+
- Added context menu to RIDE tray icon. Options Show, Hide and Close
193+
- Added synchronization with Project Explorer to navigate to
194+
selected item, Test Case, Keyword, Variable, in Text Editor
195+
- Control commands (**FOR**, **IF**, **TRY**, etc) will only be
196+
colorized as valid keywords when typed in all caps in Grid Editor
197+
- Newlines in Grid Editor can be made visible with the **filter
198+
newlines** set to False, by editing *settings.cfg*
199+
- Improve auto-suggestions of keywords in Grid Editor by allowing to
200+
close suggestions list with keys ARROW_LEFT or ARROW_RIGHT
201+
- Improve Text Editor auto-suggestions by using: selected text, text
202+
at left or at right of cursor
203+
204+
We hope to implement or complete features and make fixes on next
205+
major version 2.1 (in mid Autumm of 2024).
206+
207+
**The minimal wxPython version is, 4.0.7, and RIDE supports the
208+
current version, 4.2.2, which we recommend.**
209+
210+
*Linux users are advised to install first wxPython from .whl package
211+
at*
212+
`wxPython.org <https://extras.wxpython.org/wxPython4/extras/linux/gtk3/>`__,
213+
or by using the system package manager.
214+
215+
The
216+
`CHANGELOG.adoc <https://github.com/robotframework/RIDE/blob/master/CHANGELOG.adoc>`__
217+
lists the changes done on the different versions.
218+
219+
All issues targeted for RIDE v2.1 can be found from the `issue
220+
tracker
221+
milestone <https://github.com/robotframework/RIDE/issues?q=milestone%3Av2.1>`__.
222+
223+
Questions and comments related to the release can be sent to the
224+
`robotframework-users <https://groups.google.com/group/robotframework-users>`__
225+
mailing list or to the channel #ride on `Robot Framework
226+
Slack <https://robotframework-slack-invite.herokuapp.com>`__, and
227+
possible bugs submitted to the `issue
228+
tracker <https://github.com/robotframework/RIDE/issues>`__. You
229+
should see `Robot Framework
230+
Forum <https://forum.robotframework.org/c/tools/ride/>`__ if your
231+
problem is already known.
232+
233+
To install with `pip <https://pypi.org/project/pip/>`__ installed,
234+
just run
235+
236+
.. code:: literal-block
237+
238+
pip install --upgrade --pre robotframework-ride==v2.1b1
239+
240+
to install exactly this release, which is the same as using
241+
242+
.. code:: literal-block
243+
244+
pip install --upgrade --pre robotframework-ride
245+
246+
Alternatively you can download the source distribution from
247+
`PyPI <https://pypi.python.org/pypi/robotframework-ride>`__ and
248+
install it manually. For more details and other installation
249+
approaches, see the `installation
250+
instructions <https://github.com/robotframework/RIDE/wiki/Installation-Instructions>`__.
251+
If you want to help in the development of RIDE, by reporting issues
252+
in current development version, you can install with:
253+
254+
.. code:: literal-block
255+
256+
pip install -U https://github.com/robotframework/RIDE/archive/master.zip
257+
258+
Important document for helping with development is the
259+
`CONTRIBUTING.adoc <https://github.com/robotframework/RIDE/blob/master/CONTRIBUTING.adoc>`__.
260+
261+
See the `FAQ <https://github.com/robotframework/RIDE/wiki/F.A.Q.>`__
262+
for important info about : FOR changes and other known issues and
263+
workarounds.
264+
265+
A possible way to start RIDE is:
266+
267+
.. code:: literal-block
268+
269+
python -m robotide.__init__
270+
271+
You can then go to Tools>Create RIDE Desktop Shortcut, or run the
272+
shortcut creation script with:
273+
274+
.. code:: literal-block
275+
276+
python -m robotide.postinstall -install
277+
278+
or
279+
280+
.. code:: literal-block
281+
282+
ride_postinstall.py -install
283+
284+
RIDE v2.1b1 was released on 22/September/2024.

0 commit comments

Comments
 (0)