Skip to content

Commit

Permalink
Update version.py and update contribution docs (#454)
Browse files Browse the repository at this point in the history
* Update version.py

* Add toml dependency to GitHub workflow for publishing package

* Update 'Tests' part in CONTRIBUTING.rst
  • Loading branch information
mnojek authored Sep 1, 2021
1 parent 9d6a8ea commit d9c9ed0
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/python-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install setuptools wheel twine
pip install setuptools wheel twine toml
python -m pip install robotframework
- name: Build and publish
env:
Expand Down
18 changes: 16 additions & 2 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ Make sure to run all of the tests before submitting a pull request to be sure
that your changes do not break anything. Pull requests are also automatically
tested on continuous integration.

Most of our tests use pytest. To use it install robocop with dev profile::
Most of our tests use pytest. To use it install Robocop with ``dev`` profile::

pip install robocop[dev]

Expand All @@ -167,6 +167,20 @@ To run pytest tests navigate to directory with test files and run::
Pytest will automatically discover all the tests, run them and display
results. Make sure that tests do not fail.

Together with Robocop installed with ``dev`` dependencies, you will be able to use
`tox <https://github.com/tox-dev/tox>`_ tool (a CI task automation tool) which can run all tests on different environments.
Currently two environments are available - one with Robot Framework v3.* and one with
Robot Framework v4.*. You can simply run::

tox

and it will run all tests separately in these two environments and display the results.

If you want to run tests for only one specific environment, you can choose between
``rf3`` and ``rf4`` and run them with option ``-e``, e.g.::

tox -e rf3

Unit tests
''''''''''

Expand All @@ -183,7 +197,7 @@ You can put one or more \*.robot files inside - it will be autoscanned with ``--
Robocop output will be compared with content of ``expected_output.txt`` file.

When updating ``expected_output.txt`` file you can use two macro variables: ``${rules_dir}`` and ``${/}``.
The first is path to rules directory (so the correct path in robocop output will be printed) and the
The first is path to rules directory (so the correct path in Robocop output will be printed) and the
second is path separator - \ under Windows and / under Linux.

If you wish to use additional configuration or use different that default test data directory follow
Expand Down
2 changes: 1 addition & 1 deletion robocop/version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = '1.9.0'
__version__ = '1.10.0'

0 comments on commit d9c9ed0

Please sign in to comment.