|
1 | | -# BrowserStack Jenkins Plugin |
2 | | -============================== |
| 1 | +# Overview |
| 2 | +[BrowserStack](https://browserstack.com) gives instant access to 2000+ real mobile devices and browsers that enables developers to test their websites and mobile applications without requiring to install or maintain an internal lab of virtual machines, devices, or emulators. |
3 | 3 |
|
4 | | -Git Branch | Build | Coverage |
5 | | ------------|-------|--------- |
6 | | -master | [](https://travis-ci.org/browserstack/jenkins-plugin) | [](https://codecov.io/gh/browserstack/jenkins-plugin) |
7 | | -develop | [](https://travis-ci.org/browserstack/jenkins-plugin) | [](https://codecov.io/gh/browserstack/jenkins-plugin) |
| 4 | +This BrowserStack Jenkins plugin helps you integrate and run your test suite from a Jenkins CI server on the BrowserStack device cloud. |
8 | 5 |
|
9 | | -<!-- START doctoc generated TOC please keep comment here to allow auto update --> |
10 | | -<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> |
11 | | -**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* |
| 6 | +# Features |
| 7 | +Use the BrowserStack Jenkins plugin to: |
| 8 | +- Configure your BrowserStack credentials for your Jenkins jobs. |
| 9 | +- Set up and tear down the BrowserStack Local binary for testing internal, development, and staging environments. |
| 10 | +- Upload your app build to the BrowserStack servers (for mobile app testing in App Automate). |
| 11 | +- Embed BrowserStack test results, including video, logs, and screenshots in your Jenkins job results. |
12 | 12 |
|
13 | | -- [Features](#features) |
14 | | -- [Prerequisites](#prerequisites) |
15 | | -- [Building the Plugin](#building-the-plugin) |
16 | | - - [For Testing](#for-testing) |
17 | | - - [For Release](#for-release) |
18 | | -- [Reporting Issues](#reporting-issues) |
19 | 13 |
|
20 | | -<!-- END doctoc generated TOC please keep comment here to allow auto update --> |
| 14 | +# Prerequisites |
| 15 | +You need the following to use the plugin: |
| 16 | +- An existing Jenkins CI server (version 1.653+) |
| 17 | +- A BrowserStack account. You can [sign-up for free trial](https://www.browserstack.com/users/sign_up) if you do not have an existing account. |
21 | 18 |
|
22 | | -This plugin allows you to integrate your Selenium tests in Jenkins with BrowserStack Automate. |
| 19 | +# Installation and setup |
| 20 | +- Follow [Automate Jenkins documentation](https://www.browserstack.com/docs/automate/selenium/jenkins) to integrate your Selenium and Appium test suite for website testing in **Automate**. |
| 21 | +- Follow [App Automate Jenkins documentation](https://www.browserstack.com/docs/app-automate/appium/integrations/jenkins) to integrate your Appium test suite for native and hybrid mobile app testing in **App Automate**. |
23 | 22 |
|
24 | | -## Features |
25 | | -1. Setup and teardown BrowserStackLocal for testing internal,dev or staging environments. |
26 | | -2. Embed BrowserStack Automate Report in your Jenkins job results. |
27 | | -3. Manage BrowserStack credentials in a central location for all your BrowserStack builds. |
28 | | - |
29 | | -## Prerequisites |
30 | | -1. Minimum Jenkins version supported is 1.509. |
31 | | -2. For viewing the BrowserStack Automate report in your Jenkins job results, JUnit plugin must be installed. |
32 | | -3. The build must have the BrowserStack build tool plugin. Currently there are plugins for the following build tools, |
33 | | - * maven |
34 | | - |
35 | | -## Building the Plugin |
36 | | - |
37 | | -### For Testing |
38 | | - |
39 | | -When building the plugin package for internal testing build the *hpi* package using `mvn clean package`. This will compile the code, run unit tests and build the *hpi* package. |
40 | | -The Google Analytics tracking id that will be used by default will be the one for testing. |
41 | | - |
42 | | -### For Release |
43 | | - |
44 | | -When building the plugin package for users to install in their Jenkins instance using the command `mvn clean package -Prelease`. |
45 | | -This will do the same thing as when building the plugin **For Testing** but the production Google Analytics tracking id will be used for |
46 | | -tracking analytics, if the user has it enabled. |
47 | | - |
48 | | -## Reporting Issues |
49 | | - |
50 | | -Before creating an Issue please read the [JIRA guidelines](https://wiki.jenkins-ci.org/display/JENKINS/How+to+report+an+issue). |
51 | | - |
52 | | -* Create a [Bug](https://issues.jenkins-ci.org/secure/CreateIssue.jspa?pid=10172&issuetype=1&components=19622). |
53 | | -* Request for a [New Feature](https://issues.jenkins-ci.org/secure/CreateIssue.jspa?pid=10172&issuetype=2&components=19622). |
54 | | -* Request for an [Improvement](https://issues.jenkins-ci.org/secure/CreateIssue.jspa?pid=10172&issuetype=4&components=19622) in current functionality. |
55 | | - |
56 | | -## For Code formatting |
57 | | -Code style files are their in code_formatter folder, for eclipse and intellij idea: |
58 | | -* For Eclipse : Under Window/Preferences select Java/Code Style/Formatter. Import the settings file by selecting Import. |
59 | | -* For Intellij Idea : Settings → Code Style → Java, click Manage, and import that XML file by simply clicking Import. |
| 23 | +# Latest updates |
| 24 | +With the 1.1.7 version of the Jenkins plugin, you can now enable BrowserStack test reporting in Jenkins with all test languages and frameworks. |
60 | 25 |
|
| 26 | +# Feature requests and bug reports |
| 27 | +Please file feature requests and bug reports to [BrowserStack Support team](https://www.browserstack.com/contact?ref=help#technical-support). |
0 commit comments