Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 4.1.0 #936

Merged
merged 3 commits into from
Aug 23, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 93 additions & 0 deletions docs/releasenotes/4.1.0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
:orphan:

=============
Robocop 4.1.0
=============

This release fixes issues with ``if-can-be-used``, ``variable-overwritten-before-usage`` and
``argument-overwritten-before-usage`` rules. Also, rule severity threshold now properly respect threshold filter.
bhirsz marked this conversation as resolved.
Show resolved Hide resolved

You can install the latest available version by running

::

pip install --upgrade robotframework-robocop

or to install exactly this version

::

pip install robotframework-robocop==4.1.0

.. contents::
:depth: 2
:local:


Most important changes
======================

Documentation makeover (#916, #917)
------------------------------------
Our external documentation (https://robocop.readthedocs.io/) got makeover that hugely improves navigating and
bhirsz marked this conversation as resolved.
Show resolved Hide resolved
readability of the documentation.
bhirsz marked this conversation as resolved.
Show resolved Hide resolved

Fixes
=====
Enable ``if-can-be-used`` rule for Robot Framework 5+
-----------------------------------------------------

I0908 ``if-can-be-used`` was incorrectly enabled only for Robot Framework 4.*. It should now work for all >=4 versions.

External rules with non-Python files in the directory
-----------------------------------------------------

Robocop no longer reports a problem when loading the external rules from a directory that also contains non-Python files.

TRY/EXCEPT with shared variables scope for all branches (#925)
--------------------------------------------------------------

``variable-overwritten-before-usage`` will no longer be raised if the same variable names are used in different
branches of the ``TRY/EXCEPT`` block::

*** Test Cases ***
Example Test
TRY
${value} Possibly Failing Keyword
EXCEPT
${value} Set Variable Keyword failed # each TRY/EXCEPT/ELSE/FINALLY branch is now separate scope
END
Log To Console ${value}

Rule severity threshold and global threshold filter (#930)
-----------------------------------------------------------

Rule that uses configured severity threshold (which can dynamically set rule severity) will no longer be filtered out
by global threshold ``-t/--threshold`` if rule default severity is lower than configured threshold.

For example, given rule ``file-too-long`` which has default Warning severity and following configuration::

robocop -c file-too-long:severity_threshold:warning=600:error=700 -t E .

If file has more than 700 lines it should be reported as Error and not be filtered out by ``--threshold``.

argument-overwritten-before-usage reported on test variables (#927)
bhirsz marked this conversation as resolved.
Show resolved Hide resolved
--------------------------------------------------------------------

``argument-overwritten-before-usage`` should now clear arguments after keyword definition and it will not be
raised on next test case using the same variable names.
bhirsz marked this conversation as resolved.
Show resolved Hide resolved

Acknowledgements
================

Thanks to the whole community for submitting bug reports and feature requests.
Without you, Robocop wouldn't be in the place where it is now. All the feedback
is essential to drive the tool towards higher quality and better user
experience.

If you want to help us more, consider contributing to the project directly.
We can offer our constant support to make the work fun and effective. We do
our best to create a supportive and welcoming environment for everyone.
Feel free to ping us on our official `#robocop-linter Slack channel`_ anytime.

.. _#robocop-linter Slack channel: https://robotframework.slack.com/archives/C01AWSNKC2H
4 changes: 0 additions & 4 deletions docs/releasenotes/unreleased/fixes.1.rst

This file was deleted.

4 changes: 0 additions & 4 deletions docs/releasenotes/unreleased/fixes.2.rst

This file was deleted.

14 changes: 0 additions & 14 deletions docs/releasenotes/unreleased/fixes.3.rst

This file was deleted.

11 changes: 0 additions & 11 deletions docs/releasenotes/unreleased/fixes.4.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/releasenotes/unreleased/fixes.5.rst

This file was deleted.

3 changes: 2 additions & 1 deletion docs/releasenotes/unreleased/template.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ Rule changes
{% if fixes|length > 0 %}
Fixes
=====
bhirsz marked this conversation as resolved.
Show resolved Hide resolved
{% for note in fixes %}{{ note }}{% endfor %}
{% for note in fixes %}{{ note }}
{% endfor %}
{% endif -%}

{% if other|length > 0 %}
Expand Down
2 changes: 1 addition & 1 deletion robocop/version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "4.0.1"
__version__ = "4.1.0"
Loading