jenkins-bot has submitted this change and it was merged.
Change subject: Documentation on upgrading to 1.0.0
......................................................................
Documentation on upgrading to 1.0.0
Change-Id: I629906194dec8c720c1bbad74992a81ae2943713
---
M README.md
A UPGRADE.md
2 files changed, 65 insertions(+), 0 deletions(-)
Approvals:
Hashar: Looks good to me, approved
Jhobs: Looks good to me, but someone else must approve
jenkins-bot: Verified
diff --git a/README.md b/README.md
index 1d604d5..4807563 100644
--- a/README.md
+++ b/README.md
@@ -44,6 +44,11 @@
`gem install bundler`, or `sudo gem install bundler` if you're using a
system wide Ruby.)
+## Upgrading
+
+Please read the included `UPGRADE.md` for documentation on how to upgrade from
+one major release to another.
+
## Getting Started
Once the gem is installed, run `mediawiki-selenium-init` in your project's
diff --git a/UPGRADE.md b/UPGRADE.md
new file mode 100644
index 0000000..8be0943
--- /dev/null
+++ b/UPGRADE.md
@@ -0,0 +1,60 @@
+# Upgrading from pre-1.0 releases to 1.0.0 and above
+
+## Update your `Gemfile`
+
+First, update the `Gemfile` in your project's root directory to specify the
+new version.
+
+ gem 'mediawiki_selenium', '~> 1.0.0.pre.1'
+
+## Upgrade gems and dependencies
+
+Now run `bundle install` to update your project's gem dependencies and
+`Gemfile.lock`.
+
+## Run the initialization script
+
+Version 1.0 now includes an initialization script that can help with the setup
+of new and existing test suites. Run the script in your project's root
+directory via Bundler.
+
+ bundle exec mediawiki-selenium-init
+
+Two important files will be created if they don't already exist. The first is
+an `environments.yml` configuration file that describes the environments in
+which you intend your test suite to run. For details on how it should be
+configured, consult the "Getting Started" section of the `README`.
+
+The second file, `tests/browser/features/support/env.rb`, is for bootstrapping
+the Cucumber environment. Since you're working with an existing test suite,
+you may run into a conflict here. Just make sure that your `env.rb` contains
+the following before anything else.
+
+ require 'mediawiki_selenium'
+ require 'mediawiki_selenium/support'
+ require 'mediawiki_selenium/step_definitions'
+
+## Convert page object URLs
+
+Convert all page object URLs so that they're defined relative to the root of
+any given wiki and no longer rely on the now deprecated `URL` module. In other
+words, change page object classes like the following.
+
+ class MainPage
+ include PageObject
+ include URL
+
+ page_url URL.url('Main_Page')
+
+ # ...
+ end
+
+To something like this.
+
+ class MainPage
+ include PageObject
+
+ page_url 'Main_Page'
+
+ # ...
+ end
--
To view, visit https://gerrit.wikimedia.org/r/188251
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I629906194dec8c720c1bbad74992a81ae2943713
Gerrit-PatchSet: 2
Gerrit-Project: mediawiki/selenium
Gerrit-Branch: master
Gerrit-Owner: Dduvall <[email protected]>
Gerrit-Reviewer: Cmcmahon <[email protected]>
Gerrit-Reviewer: Hashar <[email protected]>
Gerrit-Reviewer: Jhobs <[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
