From e10fdd275ae220c885c17abbfc6671661ae34394 Mon Sep 17 00:00:00 2001
From: Brandon Istenes <bistenes@socos.me>
Date: Wed, 7 Dec 2016 20:45:03 +0300
Subject: Add environment variables to README; minor formatting and copy
 improvements

---
 README.md | 54 ++++++++++++++++++++++++++++++++++--------------------
 1 file changed, 34 insertions(+), 20 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index ec61a65..15e8030 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
 Bitbucket Pull Request Builder Plugin
-================================
+=====================================
 
 This Jenkins plugin builds pull requests from Bitbucket.org and will report the test results.
 
@@ -7,25 +7,23 @@ This Jenkins plugin builds pull requests from Bitbucket.org and will report the
 
 
 Prerequisites
-================================
+-------------
 
 - Jenkins 1.509.4 or higher.
 - https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin
 
 
 Creating a Job
-=================================
+-------------
 
 - Create a new job
-- Select Git SCM
-- Add Repository URL as bellow
-  - git@bitbucket.org:${repositoryOwner}/${repositoryName}.git
-- In Branch Specifier, type as bellow
-  - */${sourceBranch}
+- Select and configure Git SCM
+	- Add Repository URL, `git@bitbucket.org:${repositoryOwner}/${repositoryName}.git`
+	- In Branch Specifier, type `*/${sourceBranch}`
 - Under Build Triggers, check Bitbucket Pull Request Builder
 - In Cron, enter crontab for this job.
-  - ex: * * * * *
-- In Bitbucket BasicAuth Username, write your bitbucket username like jenkins@densan-labs.net
+  - e.g. `* * * * *` will check for new pull requests every minute
+- In Bitbucket BasicAuth Username, write your bitbucket username, like `jenkins@densan-labs.net`
 - In Bitbucket BasicAuth Password, write your password
 - In CI Identifier, enter an unique identifier among your Jenkins jobs related to the repo
 - In CI Name, enter a human readable name for your Jenkins server
@@ -33,30 +31,46 @@ Creating a Job
 - Write RepositoryName
 - Save to preserve your changes
 
+
 Merge the Pull Request's Source Branch into the Target Branch Before Building
-==============================================================================
-You may want Jenkins to attempt to merge your PR before doing the build -- this way it will find conflicts for you automatically.
+-----------------------------------------------------------------------------
+
+You may want Jenkins to attempt to merge your PR before building.
+This may help expose inconsistencies between the source branch and target branch.
+Note that if the merge cannot be completed, the build will fail immediately.
+
 - Follow the steps above in "Creating a Job"
 - In the "Source Code Management" > "Git" > "Additional Behaviors" section, click "Add" > "Merge Before Building"
-- In "Name of Repository" put "origin" (or, if not using default name, use your remote repository's name. Note: unlike in the main part of the Git Repository config, you cannot leave this item blank for "default".)
+- In "Name of Repository" put "origin" (or, if not using default name, use your remote repository's name. Note: unlike in the main part of the Git Repository config, you cannot leave this item blank for "default").
 - In "Branch to merge to" put "${targetBranch}" 
 - Note that as long as you don't push these changes to your remote repository, the merge only happens in your local repository.
 
-
 If you are merging into your target branch, you might want Jenkins to do a new build of the Pull Request when the target branch changes.
 - There is a checkbox that says, "Rebuild if destination branch changes?" which enables this check.
 
 
-Rerun test builds
-====================
+Rerun a Build
+-------------
+
+If you want to rerun a pull request build, write a comment on your pull request reading “test this please”.
 
-If you want to rerun pull request test, write “test this please” comment to your pull request.
 
+Environment Variables Provided
+------------------------------
 
+- `sourceBranch`
+- `targetBranch`
+- `repositoryOwner`
+- `repositoryName`
+- `pullRequestId`
+- `destinationRepositoryOwner`
+- `destinationRepositoryName`
+- `pullRequestTitle`
+- `pullRequestAuthor`
 
 
 Contributing to Bitbucket Pull Request Builder Plugin
-================================================
+-----------------------------------------------------
 
 - Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 
@@ -70,13 +84,13 @@ Contributing to Bitbucket Pull Request Builder Plugin
 
 
 Copyright
-=============================
+---------
 
 Copyright © 2014 S.nishio. 
 
 
 License
-=============================
+-------
 
 - BSD License
 - See COPYING file
-- 
cgit v1.2.3