Skip to content

chore: updated readme instructions for jenkins #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 30, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 20 additions & 53 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,27 @@
# BrowserStack Jenkins Plugin
==============================
# Overview
[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.

Git Branch | Build | Coverage
-----------|-------|---------
master | [![Build Status](https://travis-ci.org/browserstack/jenkins-plugin.svg?branch=master)](https://travis-ci.org/browserstack/jenkins-plugin) | [![codecov](https://codecov.io/gh/browserstack/jenkins-plugin/branch/master/graph/badge.svg)](https://codecov.io/gh/browserstack/jenkins-plugin)
develop | [![Build Status](https://travis-ci.org/browserstack/jenkins-plugin.svg?branch=develop)](https://travis-ci.org/browserstack/jenkins-plugin) | [![codecov](https://codecov.io/gh/browserstack/jenkins-plugin/branch/develop/graph/badge.svg)](https://codecov.io/gh/browserstack/jenkins-plugin)
This BrowserStack Jenkins plugin helps you integrate and run your test suite from a Jenkins CI server on the BrowserStack device cloud.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
# Features
Use the BrowserStack Jenkins plugin to:
- Configure your BrowserStack credentials for your Jenkins jobs.
- Set up and tear down the BrowserStack Local binary for testing internal, development, and staging environments.
- Upload your app build to the BrowserStack servers (for mobile app testing in App Automate).
- Embed BrowserStack test results, including video, logs, and screenshots in your Jenkins job results.

- [Features](#features)
- [Prerequisites](#prerequisites)
- [Building the Plugin](#building-the-plugin)
- [For Testing](#for-testing)
- [For Release](#for-release)
- [Reporting Issues](#reporting-issues)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->
# Prerequisites
You need the following to use the plugin:
- An existing Jenkins CI server (version 1.653+)
- 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.

This plugin allows you to integrate your Selenium tests in Jenkins with BrowserStack Automate.
# Installation and setup
- 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**.
- 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**.

## Features
1. Setup and teardown BrowserStackLocal for testing internal,dev or staging environments.
2. Embed BrowserStack Automate Report in your Jenkins job results.
3. Manage BrowserStack credentials in a central location for all your BrowserStack builds.

## Prerequisites
1. Minimum Jenkins version supported is 1.509.
2. For viewing the BrowserStack Automate report in your Jenkins job results, JUnit plugin must be installed.
3. The build must have the BrowserStack build tool plugin. Currently there are plugins for the following build tools,
* maven

## Building the Plugin

### For Testing

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.
The Google Analytics tracking id that will be used by default will be the one for testing.

### For Release

When building the plugin package for users to install in their Jenkins instance using the command `mvn clean package -Prelease`.
This will do the same thing as when building the plugin **For Testing** but the production Google Analytics tracking id will be used for
tracking analytics, if the user has it enabled.

## Reporting Issues

Before creating an Issue please read the [JIRA guidelines](https://wiki.jenkins-ci.org/display/JENKINS/How+to+report+an+issue).

* Create a [Bug](https://issues.jenkins-ci.org/secure/CreateIssue.jspa?pid=10172&issuetype=1&components=19622).
* Request for a [New Feature](https://issues.jenkins-ci.org/secure/CreateIssue.jspa?pid=10172&issuetype=2&components=19622).
* Request for an [Improvement](https://issues.jenkins-ci.org/secure/CreateIssue.jspa?pid=10172&issuetype=4&components=19622) in current functionality.

## For Code formatting
Code style files are their in code_formatter folder, for eclipse and intellij idea:
* For Eclipse : Under Window/Preferences select Java/Code Style/Formatter. Import the settings file by selecting Import.
* For Intellij Idea : Settings → Code Style → Java, click Manage, and import that XML file by simply clicking Import.
# Latest updates
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.

# Feature requests and bug reports
Please file feature requests and bug reports to [BrowserStack Support team](https://www.browserstack.com/contact?ref=help#technical-support).
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

<name>BrowserStack</name>
<description>This plugin allows you to integrate with BrowserStack.</description>
<url>https://wiki.jenkins-ci.org/display/JENKINS/BrowserStack+Plugin</url>
<url>https://github.com/jenkinsci/browserstack-integration-plugin</url>

<developers>
<developer>
Expand Down