jenkins-bot has submitted this change and it was merged. Change subject: Minor updates to readme file ......................................................................
Minor updates to readme file Change-Id: I53dacbaddea4870c9f8dfb5d00f63f68d0887085 --- M README.md 1 file changed, 22 insertions(+), 13 deletions(-) Approvals: Zfilipin: Looks good to me, approved jenkins-bot: Verified diff --git a/README.md b/README.md index 46c9ab2..11eae7a 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,8 @@ The easiest way to install Ruby on Linux/Unix/Mac is [RVM](https://rvm.io/) and on Windows [RubyInstaller](http://rubyinstaller.org/). -ALERT: On Windows you must use Ruby 1.9.3 for now because cucumber/gherkin -library currently doesn't work with Ruby 2.x.x. +ALERT: On Windows you must use Ruby 1.9.3 for now because Cucumber currently +doesn't work with Ruby 2. cd /tests/browser gem update --system @@ -22,7 +22,7 @@ If you're not using RVM to manage your Ruby versions, you will need to run the commands as root (using `sudo`). -Environment variables MEDIAWIKI_USER and MEDIAWIKI_PASSWORD are required for +Environment variables `MEDIAWIKI_USER` and `MEDIAWIKI_PASSWORD` are required for tests tagged `@login`. For local testing, create a test user on your local wiki and export the user and password as the values for those variables. For example: @@ -46,7 +46,9 @@ To run a single test file enter `bundle exec cucumber features/FEATURE_NAME.feature`. To run a single test scenario, put a colon and the line number (NN) on which -the scenario begins after the file name: `bundle exec cucumber features/FEATURE_NAME.feature:NN`. +the scenario begins after the file name: + + bundle exec cucumber features/FEATURE_NAME.feature:NN You can use a different browser with the `BROWSER` env variable, the fastest is probably PhantomJS, a headless browser: @@ -63,22 +65,22 @@ ## Screenshots -You can get screenshots on failures (since 0.2.1) by setting the environment -variable SCREENSHOT_FAILURES to "true", screenshots will be written under the +You can get screenshots on failures by setting the environment +variable `SCREENSHOT_FAILURES` to `true`. Screenshots will be written under the `screenshots` directory relatively to working directory. The -SCREENSHOT_FAILURES_PATH environment variable (since 0.2.2) let you override +`SCREENSHOT_FAILURES_PATH` environment variable lets you override the destination path for screenshots. Example: - SCREENSHOT_FAILURES=true SCREENSHOT_FAILURES_PATH="/tmp/screenshots" bundle exec cucumber + SCREENSHOT_FAILURES=true SCREENSHOT_FAILURES_PATH="/tmp/screenshots" bundle exec cucumber ## Update your Gemfile -In your repository, the Gemfile specify dependencies and Gemfile.lock defines +In your repository, the `Gemfile` specifies dependencies and `Gemfile.lock` defines the whole dependency tree. To update it simply run: bundle update -It will fetch all dependencies and updates the Gemfile.lock file, you can then +It will fetch all dependencies and update the `Gemfile.lock` file, you can then commit back both files. ## Links @@ -112,12 +114,19 @@ 4. Push to the branch (`git push origin my-new-feature`) 5. Create new Pull Request -https://www.mediawiki.org/wiki/QA/Browser_testing#How_to_contribute +Also see https://www.mediawiki.org/wiki/QA/Browser_testing#How_to_contribute ## Release notes ### 0.2.8 -#### Enhancements +* Possibility to set BROWSER_TIMEOUT. -* Possibility to set BROWSER_TIMEOUT +### 0.2.2 + +* `SCREENSHOT_FAILURES_PATH` environment variable lets you override the destination path for screenshots. + +### 0.2.1 + +* Get screenshots on failures by setting the environment variable `SCREENSHOT_FAILURES` to `true`. + -- To view, visit https://gerrit.wikimedia.org/r/117876 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I53dacbaddea4870c9f8dfb5d00f63f68d0887085 Gerrit-PatchSet: 2 Gerrit-Project: mediawiki/selenium Gerrit-Branch: master Gerrit-Owner: Zfilipin <zfili...@wikimedia.org> Gerrit-Reviewer: Amire80 <amir.ahar...@mail.huji.ac.il> Gerrit-Reviewer: Cmcmahon <cmcma...@wikimedia.org> Gerrit-Reviewer: KartikMistry <kartik.mis...@gmail.com> Gerrit-Reviewer: Manybubbles <never...@wikimedia.org> Gerrit-Reviewer: Tobias Gritschacher <tobias.gritschac...@wikimedia.de> Gerrit-Reviewer: Zfilipin <zfili...@wikimedia.org> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
