Screwdriver-scm-bitbucket NPM

scm-bitbucket

Downloads 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	Default	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	String	sd-buildbot	Bitbucket username for checkout
config.email	String	dev-null@screwdriver.cd	Bitbucket user email for checkout
config.https	Boolean	false	Is the Screwdriver API running over HTTPS
config.readOnly	Object	{}	Config with readOnly info: enabled, username, accessToken, cloneType
config.fusebox	Object	{}	Circuit Breaker configuration

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.