|
| 1 | +.. container:: document |
| 2 | + |
| 3 | + `RIDE (Robot Framework |
| 4 | + IDE) <https://github.com/robotframework/RIDE/>`__ v2.2.3 is a new |
| 5 | + release with some enhancements and bug fixes. The reference for valid |
| 6 | + arguments is `Robot Framework <https://robotframework.org/>`__ |
| 7 | + current version, 7.4.2. However, internal library code is originally |
| 8 | + based on version 3.1.2, but adapted for new versions. |
| 9 | + |
| 10 | + - This version supports Python 3.9 up to 3.14. |
| 11 | + - There are some changes, or known issues: |
| 12 | + |
| 13 | + - 🐞 - Rename Keywords, Find Usages/Find where used are not |
| 14 | + finding all occurrences. Please, double-check findings and |
| 15 | + changes. |
| 16 | + - 🐞 - New feature, Auto-Save, may cause problems in Grid and |
| 17 | + Text Editors and validation errors (e.g. missing END). |
| 18 | + - 🐞 - In Grid Editor, private keywords defined in test suites |
| 19 | + with **Name** setting, will show with error color even if used |
| 20 | + correctly in another local keyword. |
| 21 | + - 🐞 - RIDE **DOES NOT KEEP** Test Suites formatting or |
| 22 | + structure, causing differences in files when used on other IDE |
| 23 | + or Editors. The option to not reformat the file is not working. |
| 24 | + - 🐞 - In Grid Editor, when showing settings, scrolling down with |
| 25 | + mouse or using down is not working. You can change to Text |
| 26 | + Editor and back to Grid Editor, to restore normal behavior. |
| 27 | + - 🐞 - In Files Explorer, when in floating window, the files tree |
| 28 | + is not always using all available space. Do a small resize of |
| 29 | + window to redraw. |
| 30 | + - 🐞 - The Test Suites Explorer, may be visible or hidden with |
| 31 | + F12, or toggled floating/docked, but content may disappear. You |
| 32 | + should try to make it reappear by toggling Files Explorer, F11, |
| 33 | + or by editing **settings.cfg**. |
| 34 | + |
| 35 | + **New Features and Fixes Highlights** |
| 36 | + |
| 37 | + - Changed colorization for Control Markers. Different color from |
| 38 | + Keywords for elements: 'AND', 'BREAK', 'CONTINUE', 'ELSE', 'ELSE |
| 39 | + IF', 'END', 'EXCEPT', 'FINALLY', 'FOR', 'GROUP', 'IF', 'IN', 'IN |
| 40 | + ENUMERATE', 'IN RANGE', 'IN ZIP', 'RETURN', 'TRY', 'VAR', 'WHILE'. |
| 41 | + - Added comments field to show comments in Tags section of Test |
| 42 | + Suites in Grid Editor. |
| 43 | + - Added Auto-Save feature. Default is disabled with setting zero |
| 44 | + minutes in Preferences->Save. |
| 45 | + - Added option on Tree (Project Explorer) context menu, to **Sort |
| 46 | + Keywords (Case Insensitive)**. |
| 47 | + - Improved visibility of the Search action in **Find Usages** by |
| 48 | + adding **Search...** on the first row of the results table. |
| 49 | + - Added on Text Editor, (Preferences->Text Editor) options to |
| 50 | + **Enable visible spaces** and **Enable visible newlines**. |
| 51 | + - Added on External/Code Editor, both enabled, |
| 52 | + visible spaces |
| 53 | + and |
| 54 | + visible newlines |
| 55 | + . |
| 56 | + - Fixed exception seen in console when selecting Tools->Library |
| 57 | + Finder... on a clean install. |
| 58 | + - The Test Suites Explorer can be visible or hidden with F12 |
| 59 | + (View->View Test Suites Explorer). Pane can be made floating or |
| 60 | + docked, by dragging or by double-clicking its top bar. |
| 61 | + - In File Explorer opening non-text files is done by the operating |
| 62 | + system registered app. |
| 63 | + - Added context menu to File Explorer, to Open test suites |
| 64 | + directories or test suites files (also with double-click). |
| 65 | + - Added context menu option to Open Containing Folder, in operating |
| 66 | + system file explorer, or specific tool. |
| 67 | + - Added Config Panel button to File Explorer plugin. Here, you can |
| 68 | + set the operating system file explorer, or specify other tool, the |
| 69 | + Font style, and Colors. |
| 70 | + - Fixed persistence of the state docked/floating of File Explorer. |
| 71 | + - Fixed Cut (Ctrl-X) when editing the content of a cell in Grid |
| 72 | + Editor, before was deleting all content. |
| 73 | + |
| 74 | + **The minimal wxPython version is, 4.0.7, and RIDE supports the |
| 75 | + current version, 4.2.5, which we recommend.** |
| 76 | + |
| 77 | + *Linux users are advised to install first wxPython from .whl package |
| 78 | + at* |
| 79 | + `wxPython.org <https://extras.wxpython.org/wxPython4/extras/linux/gtk3/>`__, |
| 80 | + or by using the system package manager. |
| 81 | + |
| 82 | + The |
| 83 | + `CHANGELOG.adoc <https://github.com/robotframework/RIDE/blob/master/CHANGELOG.adoc>`__ |
| 84 | + lists the changes done on the different versions. |
| 85 | + |
| 86 | + All issues targeted for RIDE v2.3 can be found from the `issue |
| 87 | + tracker |
| 88 | + milestone <https://github.com/robotframework/RIDE/issues?q=milestone%3Av2.3>`__. |
| 89 | + |
| 90 | + Questions and comments related to the release can be sent to the |
| 91 | + `robotframework-users <https://groups.google.com/group/robotframework-users>`__ |
| 92 | + mailing list or to the channel #ride on `Robot Framework |
| 93 | + Slack <https://robotframework-slack-invite.herokuapp.com>`__, and |
| 94 | + possible bugs submitted to the `issue |
| 95 | + tracker <https://github.com/robotframework/RIDE/issues>`__. You |
| 96 | + should see `Robot Framework |
| 97 | + Forum <https://forum.robotframework.org/c/tools/ride/>`__ if your |
| 98 | + problem is already known. |
| 99 | + |
| 100 | + To install the latest release with |
| 101 | + `pip <https://pypi.org/project/pip/>`__ installed, just run |
| 102 | + |
| 103 | + .. code:: literal-block |
| 104 | +
|
| 105 | + pip install --upgrade robotframework-ride==2.2.3 |
| 106 | +
|
| 107 | + to install exactly the specified release, which is the same as using |
| 108 | + |
| 109 | + .. code:: literal-block |
| 110 | +
|
| 111 | + pip install --upgrade robotframework-ride |
| 112 | +
|
| 113 | + Alternatively you can download the source distribution from |
| 114 | + `PyPI <https://pypi.python.org/pypi/robotframework-ride>`__ and |
| 115 | + install it manually. For more details and other installation |
| 116 | + approaches, see the `installation |
| 117 | + instructions <https://github.com/robotframework/RIDE/wiki/Installation-Instructions>`__. |
| 118 | + If you want to help in the development of RIDE, by reporting issues |
| 119 | + in current development version, you can install with: |
| 120 | + |
| 121 | + .. code:: literal-block |
| 122 | +
|
| 123 | + pip install -U https://github.com/robotframework/RIDE/archive/develop.zip |
| 124 | +
|
| 125 | + Important document for helping with development is the |
| 126 | + `CONTRIBUTING.adoc <https://github.com/robotframework/RIDE/blob/develop/CONTRIBUTING.adoc>`__. |
| 127 | + |
| 128 | + To start RIDE from a command window, shell or terminal, just enter: |
| 129 | + |
| 130 | + :: |
| 131 | + |
| 132 | + ride |
| 133 | + |
| 134 | + You can also pass some arguments, like a path for a test suite file |
| 135 | + or directory. |
| 136 | + |
| 137 | + :: |
| 138 | + |
| 139 | + ride example.robot |
| 140 | + |
| 141 | + Another possible way to start RIDE is: |
| 142 | + |
| 143 | + .. code:: literal-block |
| 144 | +
|
| 145 | + python -m robotide |
| 146 | +
|
| 147 | + You can then go to Tools>Create RIDE Desktop Shortcut, or run the |
| 148 | + shortcut creation script with: |
| 149 | + |
| 150 | + .. code:: literal-block |
| 151 | +
|
| 152 | + python -m robotide.postinstall -install |
| 153 | +
|
| 154 | + or |
| 155 | + |
| 156 | + .. code:: literal-block |
| 157 | +
|
| 158 | + ride_postinstall.py -install |
| 159 | +
|
| 160 | + RIDE v2.2.3 was released on 10/Junho/2026. |
| 161 | + |
| 162 | + .. rubric:: Celebrate the bank holiday, 10th June, Day of Portugal, |
| 163 | + Portuguese Communities and Camões!! |
| 164 | + :name: celebrate-the-bank-holiday-10th-june-day-of-portugal-portuguese-communities-and-camões |
| 165 | + |
| 166 | + .. rubric:: 🇵🇹 |
| 167 | + :name: section |
0 commit comments