Skip to content
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
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Once installed, go to **Manage Jenkins > Configure System**, scroll down to wher

![credentials](https://github.com/jenkinsci/testingbot-plugin/raw/master/help/credentials.png)

The plugin uses the Credentials plugin. Click the 'Add' button and enter your key and secret, which you can obtain from the [TestingBot Member area](https://testingbot.com/members).
The plugin uses the Credentials plugin. Click the 'Add' button and enter your key and secret, which you can obtain from the [TestingBot Member area](https://testingbot.com/members). Use **Test Connection** to verify your key and secret before saving.

## Configuring a Job to use the TestingBot Plugin
![build environment](https://github.com/jenkinsci/testingbot-plugin/raw/master/help/buildenv.png)
Expand All @@ -37,13 +37,9 @@ If you want to see the test results (screenshots, logs and a video screencast of

The plugin will parse the JUnit test result files in the post-build step to associate test results with TestingBot jobs. Please make sure that JUnit plugin is installed.

![postbuild action](https://github.com/jenkinsci/testingbot-plugin/raw/master/help/postbuild.png)

Click on **Add post-build action** in **Post-build Actions**. Make sure you enable **Publish JUnit test result report** and point to the correct test report files (for example `test-reports/*.xml`).
Add the **Publish JUnit test result report** post-build action and point it at your report files (for example `test-reports/*.xml`). Then, under **Additional test report features**, add **Embed TestingBot reports**.

![publisher](https://github.com/jenkinsci/testingbot-plugin/raw/master/help/publisher.png)

Select the **Run TestingBot Test Publisher** option from the **Post Build Action** list.
![postbuild action](https://github.com/jenkinsci/testingbot-plugin/raw/master/help/postbuild.png)

The TestingBot plugin will parse both `stdout` and `stderr`, looking for lines that have this format:
`TestingBotSessionID=<sessionId>`
Expand Down Expand Up @@ -77,6 +73,10 @@ This will start the tunnel before your job runs. Once the job finishes, the tunn

`testingbotPublisher()` will try to read the JUnit report files and show the test results from TestingBot.

You can build these steps interactively with the Jenkins **Pipeline Syntax** (Snippet Generator):

![pipeline snippet generator](https://github.com/jenkinsci/testingbot-plugin/raw/master/help/snippet-generator.png)

### Environment variables

Inside **both** `testingbot { }` and `testingbotTunnel { }` blocks:
Expand Down Expand Up @@ -156,6 +156,8 @@ The plugin can publish the TestingBot outcome of a build as a GitHub check (✅/

Add the **Publish TestingBot results as a GitHub check** post-build action (freestyle), or call the `testingbotChecks` step in a pipeline:

![github check](https://github.com/jenkinsci/testingbot-plugin/raw/master/help/testingbot-checks.png)

```groovy
testingbotChecks(name: 'TestingBot', message: 'End-to-end tests on TestingBot')
```
Expand Down
Binary file modified help/buildenv.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed help/credentials-option.png
Binary file not shown.
Binary file modified help/credentials.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified help/postbuild.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed help/publisher.png
Binary file not shown.
Binary file added help/snippet-generator.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added help/testingbot-checks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.