diff --git a/README.md b/README.md index a18f9b7..47966b2 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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=` @@ -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: @@ -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') ``` diff --git a/help/buildenv.png b/help/buildenv.png index df662ae..5bf7987 100644 Binary files a/help/buildenv.png and b/help/buildenv.png differ diff --git a/help/credentials-option.png b/help/credentials-option.png deleted file mode 100644 index 95eb6d9..0000000 Binary files a/help/credentials-option.png and /dev/null differ diff --git a/help/credentials.png b/help/credentials.png index 08d8524..3b164c4 100644 Binary files a/help/credentials.png and b/help/credentials.png differ diff --git a/help/postbuild.png b/help/postbuild.png index 1249315..c0e89df 100644 Binary files a/help/postbuild.png and b/help/postbuild.png differ diff --git a/help/publisher.png b/help/publisher.png deleted file mode 100644 index c6d26d7..0000000 Binary files a/help/publisher.png and /dev/null differ diff --git a/help/snippet-generator.png b/help/snippet-generator.png new file mode 100644 index 0000000..b8004fd Binary files /dev/null and b/help/snippet-generator.png differ diff --git a/help/testingbot-checks.png b/help/testingbot-checks.png new file mode 100644 index 0000000..6db86ae Binary files /dev/null and b/help/testingbot-checks.png differ