Permalink
Browse files

Updating README.md with directions on how to set up Travis-ci

issue #1367
  • Loading branch information...
1 parent be10ff4 commit 2777bd663c82e0efb2486992a378ce6b7f721c73 @shane-tomlinson shane-tomlinson committed Mar 30, 2012
Showing with 20 additions and 1 deletion.
  1. +20 −1 README.md
View
21 README.md
@@ -2,7 +2,7 @@
- License, v. 2.0. If a copy of the MPL was not distributed with this
- file, You can obtain one at http://mozilla.org/MPL/2.0/. -->
-Here lives the [BrowserID] implementation. BrowserID is an implementation of the
+Here lives the [BrowserID] implementation. BrowserID is an implementation of the
[verified email protocol].
[BrowserID]:https://browserid.org
@@ -42,6 +42,7 @@ You can stop the servers with a Cntl-C in the terminal.
## Testing
+### Local Testing
Unit tests can be run by invoking `npm test` at the top level. At present,
there are three classes of unit tests to be run:
@@ -52,6 +53,24 @@ there are three classes of unit tests to be run:
You can control which tests are run using the `WHAT_TESTS` env var, see
`scripts/test` for details.
+### Continuous Integration Testing
+Integration tests are done with [Travis-CI]. It is recommended that you setup [Travis-CI] for your BrowserID fork so that tests are automatically run when you push changes. This will give the BrowserID team confidence that your changes both function correctly and do not cause regressions in other parts of the code. Configuration files are already included in the repo but some setup is necessary.
+
+1. Sign in to [GitHub]
+2. Open http://travis-ci.org
+3. Click "Sign in with GitHub" if you are not signed in. If you are signed in, click on your username then "Profile" and go to step 5.
+4. Click "Allow" if this is your first time signing in.
+5. Find "browserid" in "Your Repositories"
+6. Move the switch from "OFF" to "ON"
+7. Open your fork of BrowserID on [GitHub]
+8. Click the "Admin" button
+9. Click "Service Hooks"
+10. Ensure that "Travis" has a green radio button
+11. Push to your fork and return to http://travis-ci.org Watch the tests run.
+
+ [Travis-CI]: http://travis-ci.org
+ [GitHub]: https://github.com
+
## Development model
**branching & release model** - You'll notice some funky branching conventions, like the default branch is named `dev` rather than `master` as you might expect. We're using gitflow: the approach is described in a [blog post](http://lloyd.io/applying-gitflow).

0 comments on commit 2777bd6

Please sign in to comment.