|
| 1 | +.. container:: document |
| 2 | + |
| 3 | + `RIDE (Robot Framework |
| 4 | + IDE) <https://github.com/robotframework/RIDE/>`__ v2.1.5 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.3.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.8 up to 3.13 (and also tested on |
| 11 | + 3.14.a7 with wxPython 4.2.3). |
| 12 | + - There are some changes, or known issues: |
| 13 | + |
| 14 | + - 🐞 - Rename Keywords, Find Usages/Find where used are not |
| 15 | + finding all occurrences. Please, double-check findings and |
| 16 | + changes. |
| 17 | + - 🐞 - Some argument types detection (and colorization) is not |
| 18 | + correct in Grid Editor. |
| 19 | + - 🐞 - In Grid Editor, private keywords defined in test suites |
| 20 | + with **Name** setting, will show with error color even if used |
| 21 | + correctly in another local keyword. |
| 22 | + - 🐞 - RIDE **DOES NOT KEEP** Test Suites formatting or |
| 23 | + structure, causing differences in files when used on other IDE |
| 24 | + or Editors. The option to not reformat the file is not working. |
| 25 | + - 🐞 - In Grid Editor, when showing settings, scrolling down with |
| 26 | + mouse or using down is not working. You can change to Text |
| 27 | + Editor and back to Grid Editor, to restore normal behavior. |
| 28 | + |
| 29 | + **New Features and Fixes Highlights** |
| 30 | + |
| 31 | + - Added indication of **private** keywords in Grid Editor, keywords |
| 32 | + will show in *Italic*, and with error background, when they are |
| 33 | + used outside of Keywords section, or from different files. |
| 34 | + - Added indication of **private** keywords in Details pop-up for |
| 35 | + keywords with tag **robot:private** or name starting with |
| 36 | + underscore, **'\_'** in Grid Editor. |
| 37 | + - Modified the action of key TAB when selecting from |
| 38 | + auto-suggestions list in Grid Editor. Pressing TAB, selects the |
| 39 | + item and continues in cell editor. |
| 40 | + - Fix cursor position when editing cells in Grid Editor. |
| 41 | + - Added parsing of option **--name** or **-N** and **Name** setting, |
| 42 | + to allow running tests with them set. |
| 43 | + - Fix broken installation of RIDE v2.1.4 by adding missing |
| 44 | + dependencies. |
| 45 | + - Added **Tools->Library Finder...** to install libraries and |
| 46 | + **Help->Open Library Documentation...** . They share the same |
| 47 | + dialog, and definitions are recorded in \``settings.cfg`\`. |
| 48 | + - Added context menu to install libraries and to open documentation |
| 49 | + in Grid Editor Import section. Same as above description. |
| 50 | + - Added keyboard shortcuts **Ctrl-Shift-Up** and **Ctrl-Shift-Down** |
| 51 | + as alternatives to **Alt-Up** and **Alt-Down** to move rows in |
| 52 | + Grid and Text Editors. |
| 53 | + - Improved vertical scroll in Grid Editor, by having main scroll |
| 54 | + bars out of cells. |
| 55 | + - Fixed Create Desktop Shortcut by pointing executable to **python |
| 56 | + -m robotide**. |
| 57 | + - Changed arguments parser to allow **--version** and **--help** |
| 58 | + functional in Windows. |
| 59 | + - Improved auto-complete in Grid Editor, to allow several matches. |
| 60 | + - Fixed white blocks on Tree due to failed animation when test |
| 61 | + execution is too rapid, causing crash on Windows. |
| 62 | + - Added Settings Editor button to Preferences dialog, to edit |
| 63 | + settings.cfg. |
| 64 | + - Created backup of settings.cfg to allow recovering some settings |
| 65 | + when broken upgrades. |
| 66 | + - Changed some informative dialogs and JSON Editor to use the |
| 67 | + customized colors. |
| 68 | + - Added current executing keyword and other statuses to TestRunner |
| 69 | + status bar. |
| 70 | + - Modified import statements to allow running RIDE without Robot |
| 71 | + Framework installed or versions older than 6.0. |
| 72 | + - Added Config Panel button to supported installed Plugins next to |
| 73 | + their name in Plugin Manager dialog. |
| 74 | + - Added Config Panel button to Plugins, working examples in Text |
| 75 | + Editor and Test Runner. |
| 76 | + - On Windows ignore false modification on files when opening Test |
| 77 | + Suites, causing confirmation dialog. |
| 78 | + - Added divided Status Bar. Left side for main window, right side |
| 79 | + for Plugins. Working example in Text Editor, when selecting in |
| 80 | + Tree shows the filename in StatusBar. |
| 81 | + |
| 82 | + **The minimal wxPython version is, 4.0.7, and RIDE supports the |
| 83 | + current version, 4.2.3, which we recommend.** |
| 84 | + |
| 85 | + *Linux users are advised to install first wxPython from .whl package |
| 86 | + at* |
| 87 | + `wxPython.org <https://extras.wxpython.org/wxPython4/extras/linux/gtk3/>`__, |
| 88 | + or by using the system package manager. |
| 89 | + |
| 90 | + The |
| 91 | + `CHANGELOG.adoc <https://github.com/robotframework/RIDE/blob/master/CHANGELOG.adoc>`__ |
| 92 | + lists the changes done on the different versions. |
| 93 | + |
| 94 | + All issues targeted for RIDE v2.2 can be found from the `issue |
| 95 | + tracker |
| 96 | + milestone <https://github.com/robotframework/RIDE/issues?q=milestone%3Av2.2>`__. |
| 97 | + |
| 98 | + Questions and comments related to the release can be sent to the |
| 99 | + `robotframework-users <https://groups.google.com/group/robotframework-users>`__ |
| 100 | + mailing list or to the channel #ride on `Robot Framework |
| 101 | + Slack <https://robotframework-slack-invite.herokuapp.com>`__, and |
| 102 | + possible bugs submitted to the `issue |
| 103 | + tracker <https://github.com/robotframework/RIDE/issues>`__. You |
| 104 | + should see `Robot Framework |
| 105 | + Forum <https://forum.robotframework.org/c/tools/ride/>`__ if your |
| 106 | + problem is already known. |
| 107 | + |
| 108 | + To install the latest release with |
| 109 | + `pip <https://pypi.org/project/pip/>`__ installed, just run |
| 110 | + |
| 111 | + .. code:: literal-block |
| 112 | +
|
| 113 | + pip install --upgrade robotframework-ride==2.1.4.1 |
| 114 | +
|
| 115 | + to install exactly the specified release, which is the same as using |
| 116 | + |
| 117 | + .. code:: literal-block |
| 118 | +
|
| 119 | + pip install --upgrade robotframework-ride |
| 120 | +
|
| 121 | + Alternatively you can download the source distribution from |
| 122 | + `PyPI <https://pypi.python.org/pypi/robotframework-ride>`__ and |
| 123 | + install it manually. For more details and other installation |
| 124 | + approaches, see the `installation |
| 125 | + instructions <https://github.com/robotframework/RIDE/wiki/Installation-Instructions>`__. |
| 126 | + If you want to help in the development of RIDE, by reporting issues |
| 127 | + in current development version, you can install with: |
| 128 | + |
| 129 | + .. code:: literal-block |
| 130 | +
|
| 131 | + pip install -U https://github.com/robotframework/RIDE/archive/develop.zip |
| 132 | +
|
| 133 | + Important document for helping with development is the |
| 134 | + `CONTRIBUTING.adoc <https://github.com/robotframework/RIDE/blob/develop/CONTRIBUTING.adoc>`__. |
| 135 | + |
| 136 | + To start RIDE from a command window, shell or terminal, just enter: |
| 137 | + |
| 138 | + :: |
| 139 | + |
| 140 | + ride |
| 141 | + |
| 142 | + You can also pass some arguments, like a path for a test suite file |
| 143 | + or directory. |
| 144 | + |
| 145 | + :: |
| 146 | + |
| 147 | + ride example.robot |
| 148 | + |
| 149 | + Another possible way to start RIDE is: |
| 150 | + |
| 151 | + .. code:: literal-block |
| 152 | +
|
| 153 | + python -m robotide |
| 154 | +
|
| 155 | + You can then go to Tools>Create RIDE Desktop Shortcut, or run the |
| 156 | + shortcut creation script with: |
| 157 | + |
| 158 | + .. code:: literal-block |
| 159 | +
|
| 160 | + python -m robotide.postinstall -install |
| 161 | +
|
| 162 | + or |
| 163 | + |
| 164 | + .. code:: literal-block |
| 165 | +
|
| 166 | + ride_postinstall.py -install |
| 167 | +
|
| 168 | + RIDE v2.1.5 was released on 25/July/2025. |
0 commit comments