Merge pull request #22 from trik/master

Add step definition for pipeline plugin

Author: Antonio Mansilla

README.md

@@ -75,7 +75,7 @@ Third, you need to add the Bitbucket OAuth Consumer credentials. You have two wa
  4. Click **Add** button.
 7. Select the desired credentials.
 
-### Configure Jenkins to notify Bitbucket
+### Configure Jenkins to notify Bitbucket from a standard build
 
 Once you have configured the credentials, configure jenkins to notify Bitbucket.
 
@@ -84,6 +84,74 @@ Once you have configured the credentials, configure jenkins to notify Bitbucket.
 3. Select **Bitbucket notify build status**.
 4. Choose whether you want to notify the build status on Jenkins to Bitbucket.
 
+### Pipeline step to notify Bitbucket
+
+Once you have configured the credential, you can notify BitBucket from your Pipeline script through the `bitbucketStatusNotify` step.
+
+#### Usage
+
+The `bitbucketStatusNotify` step notifies the status of a build identified by a build key and build name to BitBucket.
+If `buildKey` and `buildName` parameters are not provided, a standard name will be assigned to the build (NameOfYourJob #numberOfBuild - eg. MyProject #32).
+When a `FAILED` status is sent to BitBucket, `bitbucketStatusNotify` throws an exception terminating your Pipeline.
+
+```groovy
+  ...
+  stage 'Build'
+    bitbucketStatusNotify(
+      buildState: 'INPROGRESS',
+      buildKey: 'build',
+      buildName: 'Build'
+    )
+    try {
+        myBuildFunction()
+        bitbucketStatusNotify(
+          buildState: 'SUCCESSFUL',
+          buildKey: 'build',
+          buildName: 'Build'
+        )
+    } catch(Exception e) {
+        bitbucketStatusNotify(
+          buildState: 'FAILED',
+          buildKey: 'build',
+          buildName: 'Build',
+          buildDescription: 'Something went wrong with build!'
+        )
+    }
+  stage 'Test'
+    bitbucketStatusNotify(
+      buildState: 'INPROGRESS',
+      buildKey: 'test',
+      buildName: 'Test'
+    )
+    try {
+        myTestFunction()
+        bitbucketStatusNotify(
+          buildState: 'SUCCESSFUL',
+          buildKey: 'test',
+          buildName: 'Test'
+        )
+    } catch(Exception e) {
+        bitbucketStatusNotify(
+          buildState: 'FAILED',
+          buildKey: 'test',
+          buildName: 'Test',
+          buildDescription: 'Something went wrong with tests!'
+        )
+    }
+  ...
+```
+
+#### API Summary
+
+Parameter:
+
+| Name | Type | Optional | Description |
+| --- | --- | --- | --- |
+| `buildState` | `"INPROGRESS"|"SUCCESSFUL"|"FAILED"` | no | The status of the current build phase
+| `buildKey` | String | yes | The unique key identifying the current build phase
+| `buildName` | String | yes | The build phase's name shown on BitBucket
+| `buildDescription` | String | yes | The build phase's description shown on BitBucket
+
 ## Contributions
 
 Contributions are welcome! For feature requests and bug reports please read the following Wiki page for guidelines on [how to submit an issue][how-to-submit-issue].

pom.xml

@@ -6,7 +6,7 @@
     <groupId>org.jenkins-ci.plugins</groupId>
     <artifactId>plugin</artifactId>
     <!-- Baseline Jenkins version you use to build and test the plugin. Users must have this version or newer to run. -->
-    <version>1.580.1</version>
+    <version>1.609.1</version>
     <relativePath />
   </parent>
 
@@ -20,6 +20,7 @@
     <maven-hpi-plugin.version>1.112</maven-hpi-plugin.version>
     <maven-deploy-plugin.version>2.6</maven-deploy-plugin.version>
     <wagon-http.version>2.10</wagon-http.version>
+    <workflow.version>1.11</workflow.version>
   </properties>
 
   <name>Bitbucket Build Status Notifier Plugin</name>
@@ -84,6 +85,41 @@
       <artifactId>mercurial</artifactId>
       <version>1.54</version>
     </dependency>
+    <dependency>
+      <groupId>org.jenkins-ci.plugins.workflow</groupId>
+      <artifactId>workflow-step-api</artifactId>
+      <version>${workflow.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>org.jenkins-ci.plugins.workflow</groupId>
+      <artifactId>workflow-cps</artifactId>
+      <version>${workflow.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>org.jenkins-ci.plugins.workflow</groupId>
+      <artifactId>workflow-job</artifactId>
+      <version>${workflow.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>org.jenkins-ci.plugins.workflow</groupId>
+      <artifactId>workflow-aggregator</artifactId>
+      <version>${workflow.version}</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.jenkins-ci.plugins.workflow</groupId>
+      <artifactId>workflow-aggregator</artifactId>
+      <classifier>tests</classifier>
+      <version>${workflow.version}</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.jenkins-ci.plugins.workflow</groupId>
+      <artifactId>workflow-step-api</artifactId>
+      <classifier>tests</classifier>
+      <version>${workflow.version}</version>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>com.google.code.gson</groupId>
       <artifactId>gson</artifactId>
@@ -158,4 +194,4 @@
       <url>https://repo.jenkins-ci.org/releases</url>
     </repository>
   </distributionManagement>
-</project>
+</project>