|
| 1 | +========================================= |
| 2 | +Robot Framework 4.1.2 release candidate 2 |
| 3 | +========================================= |
| 4 | + |
| 5 | +.. default-role:: code |
| 6 | + |
| 7 | +`Robot Framework`_ 4.1.2 contains few bug fixes and considerable enhancement |
| 8 | +to memory usage. It is the last planned release in the RF 4.1.x series. |
| 9 | +It is also the last planned release to support Python 2 that itself |
| 10 | +`has not been supported since January 2020`__. Unfortunately this also means |
| 11 | +the end of our Jython__ and IronPython__ support, at least until they get |
| 12 | +Python 3 compatible versions released. |
| 13 | + |
| 14 | +__ https://www.python.org/doc/sunset-python-2/ |
| 15 | +__ http://jython.org |
| 16 | +__ http://ironpython.net |
| 17 | + |
| 18 | +Questions and comments related to the release can be sent to the |
| 19 | +`robotframework-users`_ mailing list or to `Robot Framework Slack`_, |
| 20 | +and possible bugs submitted to the `issue tracker`_. |
| 21 | + |
| 22 | +If you have pip_ installed, just run |
| 23 | + |
| 24 | +:: |
| 25 | + |
| 26 | + pip install --pre --upgrade robotframework |
| 27 | + |
| 28 | +to install the latest available release or use |
| 29 | + |
| 30 | +:: |
| 31 | + |
| 32 | + pip install robotframework==4.1.2rc2 |
| 33 | + |
| 34 | +to install exactly this version. Alternatively you can download the source |
| 35 | +distribution from PyPI_ and install it manually. For more details and other |
| 36 | +installation approaches, see the `installation instructions`_. |
| 37 | + |
| 38 | +Robot Framework 4.1.2 rc 1 was released on Sunday October 10, 2021. |
| 39 | +The final release is targeted for Thursday October 14, 2021. If you are still |
| 40 | +using Python 2, Jython or IronPython, we highly recommend you to test this |
| 41 | +release candidate in your own environment before that. Reported problems |
| 42 | +will still be fixed before the release, even if that would delay the release, |
| 43 | +but there are no plans for further RF 4.1.x releases after that. |
| 44 | + |
| 45 | +.. _Robot Framework: http://robotframework.org |
| 46 | +.. _Robot Framework Foundation: http://robotframework.org/foundation |
| 47 | +.. _pip: http://pip-installer.org |
| 48 | +.. _PyPI: https://pypi.python.org/pypi/robotframework |
| 49 | +.. _issue tracker milestone: https://github.com/robotframework/robotframework/issues?q=milestone%3Av4.1.2 |
| 50 | +.. _issue tracker: https://github.com/robotframework/robotframework/issues |
| 51 | +.. _robotframework-users: http://groups.google.com/group/robotframework-users |
| 52 | +.. _Robot Framework Slack: https://robotframework-slack-invite.herokuapp.com |
| 53 | +.. _installation instructions: ../../INSTALL.rst |
| 54 | + |
| 55 | +.. contents:: |
| 56 | + :depth: 2 |
| 57 | + :local: |
| 58 | + |
| 59 | +Most important enhancements |
| 60 | +=========================== |
| 61 | + |
| 62 | +Reduce memory usage |
| 63 | +------------------- |
| 64 | + |
| 65 | +RF 4.1.2 uses considerably less memory than earlier versions especially when |
| 66 | +processing large output.xml files. Exact numbers vary depending on the executed |
| 67 | +tests or tasks, but the reduction compared to RF 4.1.1 can be over 30%. (`#4114`_) |
| 68 | + |
| 69 | +Memory usage was profiled using the `Fil <https://pythonspeed.com/fil/>`_ tool. |
| 70 | + |
| 71 | +Java integration fixes |
| 72 | +---------------------- |
| 73 | + |
| 74 | +RF 4.1.2 being the last planned release to support Jython and Java, it is good that |
| 75 | +these two high priority issues were fixed in it: |
| 76 | + |
| 77 | +- Java versions with version number not in format `<major>.<minor>.<patch>` |
| 78 | + (e.g. `16.0.1`) did not work at all. OpenJDK releases use just `<major>` as |
| 79 | + their initial version number adding `<minor>` and `<patch>` parts only in |
| 80 | + possible bug fix releases. As the result, using Robot Framework on, for example, |
| 81 | + OpenJDK 17 was not possible at all. (`#4100`_) |
| 82 | + |
| 83 | +- Extending the standalone JAR distribution was not possible. (`#3780`_) |
| 84 | + |
| 85 | +Lines starting with `|` not followed by space caused crash |
| 86 | +---------------------------------------------------------- |
| 87 | + |
| 88 | +For example, lines like `||` and `|whatever` crashed Robot Framework's parser |
| 89 | +for good preventing execution altogether. (`#4082`_) |
| 90 | + |
| 91 | +Acknowledgements |
| 92 | +================ |
| 93 | + |
| 94 | +Robot Framework 4.1.2 development has been sponsored by the `Robot Framework Foundation`_ |
| 95 | +and its `close to 50 member organizations <https://robotframework.org/foundation/#members>`_. |
| 96 | +Big thanks for the foundation for its continued support! If your organization is using |
| 97 | +Robot Framework and finds it useful, consider joining the foundation to make make |
| 98 | +sure it is maintained and developed further also in the future. |
| 99 | + |
| 100 | +Robot Framework 4.1.2 was a pretty small release, but there was one great pull |
| 101 | +request by the wider open source community. Thanks `Michel Hidalgo |
| 102 | +<https://github.com/hidmic>`__ for enhancing error handling with |
| 103 | +reStructuredText files. (`#4086`_) |
| 104 | + |
| 105 | +Big thanks also to everyone else who has submitted bug reports, helped debugging |
| 106 | +problems, or otherwise helped with this release. |
| 107 | + |
| 108 | +| `Pekka Klärck <https://github.com/pekkaklarck>`__ |
| 109 | +| Robot Framework Creator |
| 110 | +
|
| 111 | +Full list of fixes and enhancements |
| 112 | +=================================== |
| 113 | + |
| 114 | +.. list-table:: |
| 115 | + :header-rows: 1 |
| 116 | + |
| 117 | + * - ID |
| 118 | + - Type |
| 119 | + - Priority |
| 120 | + - Summary |
| 121 | + - Added |
| 122 | + * - `#4100`_ |
| 123 | + - bug |
| 124 | + - critical |
| 125 | + - Java versions with version number not in format `<major>.<minor>.<patch>` do not work (e.g. OpenJDK 17) |
| 126 | + - rc 1 |
| 127 | + * - `#4082`_ |
| 128 | + - bug |
| 129 | + - high |
| 130 | + - Lines starting with `|` not followed by space cause crash |
| 131 | + - rc 1 |
| 132 | + * - `#4114`_ |
| 133 | + - enhancement |
| 134 | + - high |
| 135 | + - Reduce memory usage |
| 136 | + - rc 2 |
| 137 | + * - `#3780`_ |
| 138 | + - bug |
| 139 | + - medium |
| 140 | + - Extending JAR distribution fails |
| 141 | + - rc 1 |
| 142 | + * - `#4065`_ |
| 143 | + - bug |
| 144 | + - medium |
| 145 | + - Process: Started processes can hang due to how stdin is configured |
| 146 | + - rc 1 |
| 147 | + * - `#4086`_ |
| 148 | + - bug |
| 149 | + - medium |
| 150 | + - All irrelevant errors are not silenced when parsing reStructuredText data |
| 151 | + - rc 1 |
| 152 | + * - `#4112`_ |
| 153 | + - bug |
| 154 | + - medium |
| 155 | + - Incompatible output.xml created if listener runs keyword in `end_keyword` inside FOR loop |
| 156 | + - rc 2 |
| 157 | + * - `#4102`_ |
| 158 | + - enhancement |
| 159 | + - medium |
| 160 | + - Process: Make it possible to configure standard input stream |
| 161 | + - rc 1 |
| 162 | + |
| 163 | +Altogether 8 issues. View on the `issue tracker <https://github.com/robotframework/robotframework/issues?q=milestone%3Av4.1.2>`__. |
| 164 | + |
| 165 | +.. _#4100: https://github.com/robotframework/robotframework/issues/4100 |
| 166 | +.. _#4082: https://github.com/robotframework/robotframework/issues/4082 |
| 167 | +.. _#4114: https://github.com/robotframework/robotframework/issues/4114 |
| 168 | +.. _#3780: https://github.com/robotframework/robotframework/issues/3780 |
| 169 | +.. _#4065: https://github.com/robotframework/robotframework/issues/4065 |
| 170 | +.. _#4086: https://github.com/robotframework/robotframework/issues/4086 |
| 171 | +.. _#4112: https://github.com/robotframework/robotframework/issues/4112 |
| 172 | +.. _#4102: https://github.com/robotframework/robotframework/issues/4102 |
0 commit comments