aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorIgor Pashev <pashev.igor@gmail.com>2018-09-08 13:01:29 +0300
committerIgor Pashev <pashev.igor@gmail.com>2018-09-08 13:24:32 +0300
commitcdef13254a2bd5c104ddbb392545828879865c16 (patch)
treec9fdecb25384582f8ede335ed540ea99e74b79bf /README.md
parent94a11c031fca39dc927fa4dd1c362e09df840e8b (diff)
downloadbbprb-cdef13254a2bd5c104ddbb392545828879865c16.tar.gz
Really allow rebuilding pull requests
(With the Rebuild plugin - https://wiki.jenkins.io/display/JENKINS/Rebuild+Plugin) * Make builds implicitly parameterized. * Make sure `bbprb*` are passed in environment and preserved. * Update Jenkins requirements to 2.60+
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 15 insertions, 12 deletions
diff --git a/README.md b/README.md
index 2b969ed..4cff261 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@ BBPRB
This plugin is a revision of original [Bitbucket Pull Request Builder Plugin](https://wiki.jenkins.io/display/JENKINS/Bitbucket+pullrequest+builder+plugin).
It was started by adding support for [Bitbucket webhooks](https://confluence.atlassian.com/bitbucket/manage-webhooks-735643732.html)
-and resulted in massive rewrite and deleting the code.
+and resulted in massive rewrite and deleting the code. Jenkins 2.60+ is required.
Configuration
@@ -16,13 +16,7 @@ This plugin needs credentials to access Bitbucket API. The credentials comprise
the user's name and a password. This password is known as "App password" and
it is not the same as the user's password.
-Only Git repositories are supported. No special configration is required
-for the [Git plugin](https://plugins.jenkins.io/git), but the repository URL
-should point to the same repository specified for this plugins. In fact,
-they may not match. After receiving a web-hook this plugin uses its options
-to find a job to be triggered, sets some relevant options (like commit hash)
-and starts the build. If repositories are not the same, you will just get a
-failure because the hash is not found, etc.
+Only Git repositories are supported.
These environment variables are set when the job is triggered by this plugin:
@@ -38,6 +32,19 @@ bbprbSourceCommitHash
bbprbSourceRepository
```
+Recommended Git configuration:
+
+* Repository URL: `git@bitbucket.org:${bbprbDestinationRepository}.git`
+* Branch Specifier: `${bbprbSourceCommitHash}`
+* [Optional] Branch to merge to: `${bbprbDestinationBranch}`
+
+![Recommended git configuration](./screenshots/bbprb-git-config.png)
+
+
+Trigger's options in Jenkins graphical user interface:
+
+![Jenkins trigger configuration](./screenshots/bbprb-config.png)
+
Trigger's options in the job's XML configuration file:
@@ -55,10 +62,6 @@ Trigger's options in the job's XML configuration file:
```
-Trigger's options in Jenkins graphical user interface:
-
-![Jenkins trigger configuration](./screenshots/bbprb-config.png)
-
Configuring Bitbucket web-hook
------------------------------