Skip to content

Commit af78296

Browse files
Fix full path keywords (#158)
* Prepare release of 2.1.1 * Version 2.1.1 * Update changelog * Add unit tests * Fix embedded arguments keywords not being recognized when full resource path used * Fixed no recognition of keywords with embedded arguments and full name. Closes #1106 * Fix unit tests for embedded arguments handler. Removed Telnet for unit tests with Python < 3.13 * Fix unit tests * Small doc change
1 parent dd209ac commit af78296

File tree

20 files changed

+334
-91
lines changed

20 files changed

+334
-91
lines changed

CHANGELOG.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,14 @@ All notable changes to this project will be documented in this file.
66
The format is based on http://keepachangelog.com/en/1.0.0/[Keep a Changelog]
77
and this project adheres to http://semver.org/spec/v2.0.0.html[Semantic Versioning].
88

9-
109
== https://github.com/robotframework/RIDE[Unreleased]
1110

11+
=== Fixed
12+
13+
- Fixed no recognition of keywords with embedded arguments and full name. Issue #1106 from 12 Sep 2012.
14+
15+
== https://github.com/robotframework/RIDE/blob/master/doc/releasenotes/ride-2.1.1.rst[2.1.1] - 2024-11-14
16+
1217
=== Changed
1318

1419
- Changed the workflow for the development versions of RIDE. Now, development versions are taken from the ``develop`` branch, and the ``master`` will stay with released version.

CONTRIBUTING.adoc

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ the generic https://opensource.guide/[Open Source Guides] first.
2222
Bugs and enhancements are tracked in the
2323
https://github.com/robotframework/RIDE/issues[issue tracker].
2424
If you are unsure if something is a bug or is a feature worth
25-
implementing, you can first ask on link:https://forum.robotframework.org/c/tools/ride/21/[RIDE-users]
26-
(#RIDE on irc.freenode.net), or on
25+
implementing, you can first ask on link:https://forum.robotframework.org/c/tools/ride/21/[RIDE]
26+
(RIDE at Forum), or on
2727
https://robotframework-slack-invite.herokuapp.com[Slack]. These and
2828
other similar forums, not the issue tracker, are also places where to
2929
ask general questions.
@@ -105,6 +105,33 @@ to create dedicated topic branches for pull requests instead of creating
105105
them based on the master branch. This is especially important if you
106106
plan to work on multiple pull requests at the same time.
107107

108+
=== RIDE Code Setup
109+
110+
The basic code setup of RIDE, needs a additional steps since v2.1.1 (November 2024):
111+
112+
. Forking the project (Web interface)
113+
. Clone (for example) ``git clone [email protected]:robotframework/RIDE.git``
114+
. ``cd RIDE``
115+
. `pip install -U -r requirements-dev.txt`
116+
. ``git submodule init``
117+
. ``git submodule update``
118+
119+
Then you may change to the ``develop`` branch, which should be the base for features or fixes branches, and the target for pull requests. Example:
120+
121+
. ``git checkout develop``
122+
. ``git submodule init``
123+
. ``git submodule update``
124+
. ``git pull origin develop``
125+
. ``git checkout -b a_new_branch_based_on_develop``
126+
. After changes, you add new files, ``git add a_new_file``
127+
. You add and commit the modified files, ``git -a -m "The short message with info about the change``
128+
. You push the commit to your fork, ``git push origin a_new_branch_based_on_develop``
129+
. You may repeat the commit/push and when ready create a Pull Request to your ``develop`` branch, or
130+
. You checkout your ``develop``branch, and merge with ``git merge a_new_branch_based_on_develop``
131+
. Later you should keep the ``develop`` branch updated by pulling from your remote, ``git pull origin develop``, or
132+
. By pushing ``git push origin develop``
133+
. Finaly, you can create a Pull Request from your fork to the target ``develop`` branch of the original RIDE project.
134+
108135
=== Coding conventions
109136

110137
NOTE: RIDE graphical user interface, can only exist due the use of wxPython (from wxWidgets). Users wanting to write Python code for RIDE, should be acquainted with https://wxpython.org[wxPython] in particular by exploring its demo.
@@ -122,7 +149,7 @@ should be clear enough that comments are generally not needed.
122149

123150
All code, including test code, must be compatible with all supported
124151
Python interpreters and versions. Most importantly this means that the
125-
code must support Python 3 (actually, greater than 3.6). RIDE's code still have some Python 2 conditioning, due to its dual compatibility on version 1.7.4.2, and also in the included Robot Framework library from version 3.1.2.
152+
code must support Python 3 (actually, greater than 3.7, currently 3.13). RIDE's code may still have some Python 2 conditioning, due to its dual compatibility on version 1.7.4.2, and also in the included Robot Framework library from version 3.1.2.
126153

127154
==== Line length
128155

@@ -225,7 +252,7 @@ Please contact us via Slack, if you would like to join this testing group.
225252
Once you have code, documentation and tests ready, it is time to
226253
finalize the pull request.
227254

228-
=== Acknowledgments
255+
=== Acknowledgements
229256

230257
If you have done any non-trivial change and would like to be credited,
231258
remind us to add `acknowledge` tag to the issue. This way we will add

README.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ See the https://github.com/robotframework/RIDE/blob/master/doc/releasenotes/ride
3131
**Version https://github.com/robotframework/RIDE/tree/release/1.7.4.2[1.7.4.2] was the last release supporting Python 2.7**
3232

3333

34-
**The current development version is based on 2.1, supports Python from 3.8 up to 3.13 (5th November 2024).**
34+
**The current development version is based on 2.1,1, supports Python from 3.8 up to 3.13 (20th November 2024).**
3535

3636
Currently, the unit tests are tested on Python 3.10, 3.11 and 3.13 (but 3.12 is the recommended version).
3737
Likewise, the current version of wxPython, is 4.2.2, but RIDE is known to work with 4.0.7 and 4.1.1 versions.
@@ -40,7 +40,7 @@ Likewise, the current version of wxPython, is 4.2.2, but RIDE is known to work w
4040

4141
`pip install -U robotframework-ride`
4242

43-
(3.8 &lt;= python &lt;= 3.13) Install current development version (**2.1.1**) with:
43+
(3.8 &lt;= python &lt;= 3.13) Install current development version (**2.2dev1**) with:
4444

4545
`pip install -U https://github.com/robotframework/RIDE/archive/develop.zip`
4646

doc/releasenotes/ride-2.1.1.rst

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
.. container:: document
2+
3+
`RIDE (Robot Framework
4+
IDE) <https://github.com/robotframework/RIDE/>`__ v2.1.1 is a new
5+
release with some enhancements and bug fixes. The reference for valid
6+
arguments is `Robot Framework <https://robotframework.org/>`__
7+
installed version, which is at this moment 7.1.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.13.
12+
- There are some changes, or known issues:
13+
14+
- 🐞 - When upgrading RIDE and activate Restart, some errors are
15+
visible about missing /language file, and behaviour is not
16+
normal. Better to close RIDE and start a new instance.
17+
- 🐞 - Problems with COPY/PASTE in Text Editor have been reported
18+
when using wxPython 4.2.0, but not with version 4.2.1 and
19+
4.2.2, which we now *recommend*.
20+
- 🐞 - Some argument types detection (and colorization) is not
21+
correct in Grid Editor.
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+
26+
**New Features and Fixes Highlights**
27+
28+
- Fixed long arguments in fixtures appearing splitted in Grid
29+
Editor. Still, arguments info will not be correct at calling
30+
step.
31+
- Fixed double action on Linux when pressing the DEL key
32+
33+
**The minimal wxPython version is, 4.0.7, and RIDE supports the
34+
current version, 4.2.2, which we recommend.**
35+
36+
*Linux users are advised to install first wxPython from .whl package
37+
at*
38+
`wxPython.org <https://extras.wxpython.org/wxPython4/extras/linux/gtk3/>`__,
39+
or by using the system package manager.
40+
41+
The
42+
`CHANGELOG.adoc <https://github.com/robotframework/RIDE/blob/master/CHANGELOG.adoc>`__
43+
lists the changes done on the different versions.
44+
45+
All issues targeted for RIDE v2.2 can be found from the `issue
46+
tracker
47+
milestone <https://github.com/robotframework/RIDE/issues?q=milestone%3Av2.2>`__.
48+
49+
Questions and comments related to the release can be sent to the
50+
`robotframework-users <https://groups.google.com/group/robotframework-users>`__
51+
mailing list or to the channel #ride on `Robot Framework
52+
Slack <https://robotframework-slack-invite.herokuapp.com>`__, and
53+
possible bugs submitted to the `issue
54+
tracker <https://github.com/robotframework/RIDE/issues>`__. You
55+
should see `Robot Framework
56+
Forum <https://forum.robotframework.org/c/tools/ride/>`__ if your
57+
problem is already known.
58+
59+
To install the latest release with
60+
`pip <https://pypi.org/project/pip/>`__ installed, just run
61+
62+
.. code:: literal-block
63+
64+
pip install --upgrade robotframework-ride==2.1.1
65+
66+
to install exactly the specified release, which is the same as using
67+
68+
.. code:: literal-block
69+
70+
pip install --upgrade robotframework-ride
71+
72+
Alternatively you can download the source distribution from
73+
`PyPI <https://pypi.python.org/pypi/robotframework-ride>`__ and
74+
install it manually. For more details and other installation
75+
approaches, see the `installation
76+
instructions <https://github.com/robotframework/RIDE/wiki/Installation-Instructions>`__.
77+
If you want to help in the development of RIDE, by reporting issues
78+
in current development version, you can install with:
79+
80+
.. code:: literal-block
81+
82+
pip install -U https://github.com/robotframework/RIDE/archive/develop.zip
83+
84+
Important document for helping with development is the
85+
`CONTRIBUTING.adoc <https://github.com/robotframework/RIDE/blob/develop/CONTRIBUTING.adoc>`__.
86+
87+
To start RIDE from a command window, shell or terminal, just enter:
88+
89+
::
90+
91+
ride
92+
93+
You can also pass some arguments, like a path for a test suite file
94+
or directory.
95+
96+
::
97+
98+
ride example.robot
99+
100+
Another possible way to start RIDE is:
101+
102+
.. code:: literal-block
103+
104+
python -m robotide
105+
106+
You can then go to Tools>Create RIDE Desktop Shortcut, or run the
107+
shortcut creation script with:
108+
109+
.. code:: literal-block
110+
111+
python -m robotide.postinstall -install
112+
113+
or
114+
115+
.. code:: literal-block
116+
117+
ride_postinstall.py -install
118+
119+
RIDE v2.1.1 was released on 14/November/2024.

setup.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@
7474
Programming Language :: Python :: 3.10
7575
Programming Language :: Python :: 3.11
7676
Programming Language :: Python :: 3.12
77+
Programming Language :: Python :: 3.13
7778
Topic :: Software Development :: Testing
7879
""".strip().splitlines()
7980

@@ -114,7 +115,7 @@ def run(self):
114115
package_dir={'': SOURCE_DIR},
115116
packages=find_packages(SOURCE_DIR),
116117
package_data=PACKAGE_DATA,
117-
python_requires='>=3.8, <3.13',
118+
python_requires='>=3.8, <=3.13',
118119
# Robot Framework package data is not included, but RIDE does not need it.
119120
# Always install everything, since we may be switching between versions
120121
options={'install': {'force': True}},

0 commit comments

Comments
 (0)