jenkins-bot has submitted this change and it was merged.

Change subject: Improve README section on running with env name
......................................................................


Improve README section on running with env name

Change-Id: Ia9e03d2ee1670c99b4354babf897f0fcfc22c77d
---
M README.md
1 file changed, 23 insertions(+), 9 deletions(-)

Approvals:
  Hashar: Looks good to me, approved
  jenkins-bot: Verified



diff --git a/README.md b/README.md
index df2f1ba..7c2b89f 100644
--- a/README.md
+++ b/README.md
@@ -97,16 +97,30 @@
 
     bundle exec cucumber feature/some.feature:11
 
-The set of default configuration to use (see "Getting started") is specified
-by the `MEDIAWIKI_ENVIRONMENT` environment variable, which should be defined
-somewhere in your shell profile. For example, if you're using
-[Mediawiki-Vagrant](http://www.mediawiki.org/wiki/MediaWiki-Vagrant) for your
-development and executing tests on the host OS, the environment name would be
-`mw-vagrant-host`.
+The set of default configuration to use (see "Getting started") can be
+specified by the `MEDIAWIKI_ENVIRONMENT` environment variable, defined
+somewhere in your shell profile. If no value is set, an entry called `default`
+is loaded.
 
-    export MEDIAWIKI_ENVIRONMENT=mw-vagrant-host # Linux/Unix/Mac
-    set MEDIAWIKI_URL=mw-vagrant-host # Windows Command Prompt
-    $env:MEDIAWIKI_URL="mw-vagrant-host" # Windows PowerShell
+For example, if your `environments.yml` file looked something like this.
+
+    mw-vagrant-host: &default
+      mediawiki_url: http://127.0.0.1:8080/wiki/
+      # ...
+
+    mw-vagrant-guest:
+      mediawiki_url: http://127.0.0.1/wiki/
+      # ...
+
+    beta:
+      mediawiki_url: http://en.wikipedia.beta.wmflabs.org/wiki/
+      # ...
+
+    default: *default
+
+Defining `MEDIAWIKI_ENVIRONMENT=beta` in your shell would tell MW-Selenium to
+use the configuration for `beta` above. Leaving it unset would use the entry
+called `default` which in this case points to `mw-vagrant-host`.
 
 Firefox is the default browser, but you can specify a different one by setting
 `BROWSER`.

-- 
To view, visit https://gerrit.wikimedia.org/r/198087
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: Ia9e03d2ee1670c99b4354babf897f0fcfc22c77d
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/selenium
Gerrit-Branch: master
Gerrit-Owner: Dduvall <[email protected]>
Gerrit-Reviewer: Cmcmahon <[email protected]>
Gerrit-Reviewer: Hashar <[email protected]>
Gerrit-Reviewer: Zfilipin <[email protected]>
Gerrit-Reviewer: jenkins-bot <>

_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to