Bitbucket implementation of the scm-base class
JavaScript
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
test
.editorconfig
.eslintignore
.eslintrc.yaml
.gitignore
.npmignore
CONTRIBUTING.md
LICENSE
README.md
index.js
package.json
screwdriver.yaml

README.md

scm-bitbucket

Version Downloads Build Status Open Issues Dependency Status License

This scm plugin extends the scm-base-class, and provides methods to fetch and update data in Bitbucket.

Usage

npm install screwdriver-scm-bitbucket

Initialization

The class has a variety of knobs to tweak when interacting with Bitbucket.org.

Parameter Type Description
config Object Configuration Object
config.oauthClientId String OAuth Client ID provided by Bitbucket application
config.oauthClientSecret String OAuth Client Secret provided by Bitbucket application
config.username (sd-buildbot) String Bitbucket username for checkout
config.email (dev-null@screwdriver.cd) String Bitbucket user email for checkout
config.https (false) Boolean Is the Screwdriver API running over HTTPS
config.fusebox ({}) Object [Circuit Breaker configuration][circuitbreaker]
const scm = new BitbucketScm({
    oauthClientId: 'your-client-id',
    oauthClientSecret: 'your-client-secret'
});

Methods

getScmContexts

No parameters are required.

Expected Outcome

A single element array of ScmContext(ex: ['bitbucket:bitbucket.org']), which will be a unique identifier for the scm. Since scm-bitbucket supports only 'bitbucket.org' now, this method returns fixed value.

For more information on the exposed methods please see the scm-base-class.

Testing

npm test

License

Code licensed under the BSD 3-Clause license. See LICENSE file for terms.