From 5fa1952a2e582f2c428584c5ccc1800132559df0 Mon Sep 17 00:00:00 2001 From: Igor Pashev Date: Tue, 5 Dec 2017 11:37:56 +0300 Subject: Version 0.1.0 --- README.md | 133 ++++---------------------------------------------------------- 1 file changed, 7 insertions(+), 126 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 88e74ea..74514e7 100644 --- a/README.md +++ b/README.md @@ -1,135 +1,16 @@ -Bitbucket Pull Request Builder Plugin -===================================== +BBPRB +===== -This Jenkins plugin builds pull requests from Bitbucket.org and will report the test results. +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. -[![Build Status](https://travis-ci.org/nishio-dens/bitbucket-pullrequest-builder-plugin.svg?branch=master)](https://travis-ci.org/nishio-dens/bitbucket-pullrequest-builder-plugin) - - -Prerequisites -------------- - -- Jenkins 1.625.3 or higher. -- https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin - - -Creating a Job -------------- - -- Create a new job -- 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. - - 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 -- Write RepositoryOwner -- Write RepositoryName -- Save to preserve your changes - - -Jenkins pipeline -------------- -``` -pipeline { - agent any - triggers{ - bitbucketpr(projectPath:'', - cron:'H/15 * * * *', - credentialsId:'', - username:'', - password:'', - repositoryOwner:'', - repositoryName:'', - branchesFilter:'', - branchesFilterBySCMIncludes:false, - ciKey:'', - ciName:'', - ciSkipPhrases:'', - checkDestinationCommit:false, - approveIfSuccess:false, - cancelOutdatedJobs:true, - commentTrigger:'') - } -} -``` - -After you set up your Jenkins pipeline, run the job for the first time manually (otherwise the trigger may not work!) - - -Merge the Pull Request's Source Branch into the Target Branch Before Building ------------------------------------------------------------------------------ - -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 "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 a Build -------------- - -If you want to rerun a pull request build, write a comment on your pull request reading “test this please”. - - -Environment Variables Provided ------------------------------- - -- `sourceBranch` -- `targetBranch` -- `repositoryOwner` -- `repositoryName` -- `pullRequestId` -- `destinationRepositoryOwner` -- `destinationRepositoryName` -- `pullRequestTitle` -- `pullRequestAuthor` - - -Contributing to Bitbucket Pull Request Builder Plugin ------------------------------------------------------ - -- Do not use Fork [jenkinsci/bitbucket-pullrequest-builder-plugin](https://github.com/jenkinsci/bitbucket-pullrequest-builder-plugin) for contribution - -- Use project [nishio-dens/bitbucket-pullrequest-builder-plugin](https://github.com/nishio-dens/bitbucket-pullrequest-builder-plugin) - -- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet. - -- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it. - -- Fork the project. - -- Start a feature/bugfix branch. - -- Commit and push until you are happy with your contribution. - - - -Donations ------------------------------------------------------ -Do you like this plugin? feel free to donate! - -Paypal: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=LTXCF78GJ7224 - -BTC: 1KgwyVzefeNzJhuzqLq36E3bZi2WFjibMr - -Thank you! Copyright --------- +Copyright © 2017 Igor Pashev + Copyright © 2014 S.nishio + Martin Damovsky -- cgit v1.2.3