https://github.com/screwdriver-cd/scm-bitbucket
Bitbucket implementation of the scm-base class
https://github.com/screwdriver-cd/scm-bitbucket
Last synced: 11 months ago
JSON representation
Bitbucket implementation of the scm-base class
- Host: GitHub
- URL: https://github.com/screwdriver-cd/scm-bitbucket
- Owner: screwdriver-cd
- License: other
- Created: 2016-10-10T19:12:13.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-11-08T17:52:48.000Z (over 1 year ago)
- Last Synced: 2024-11-08T18:36:30.647Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://cd.screwdriver.cd/pipelines/15
- Size: 262 KB
- Stars: 0
- Watchers: 16
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# scm-bitbucket
[![Version][npm-image]][npm-url] ![Downloads][downloads-image] [![Build Status][status-image]][status-url] [![Open Issues][issues-image]][issues-url] ![License][license-image]
> This scm plugin extends the [scm-base-class](https://github.com/screwdriver-cd/scm-base), and provides methods to fetch and update data in Bitbucket.
## Usage
```bash
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][circuitbreaker] |
```js
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
```bash
npm test
```
## License
Code licensed under the BSD 3-Clause license. See LICENSE file for terms.
[npm-image]: https://img.shields.io/npm/v/screwdriver-scm-bitbucket.svg
[npm-url]: https://npmjs.org/package/screwdriver-scm-bitbucket
[downloads-image]: https://img.shields.io/npm/dt/screwdriver-scm-bitbucket.svg
[license-image]: https://img.shields.io/npm/l/screwdriver-scm-bitbucket.svg
[issues-image]: https://img.shields.io/github/issues/screwdriver-cd/screwdriver.svg
[issues-url]: https://github.com/screwdriver-cd/screwdriver/issues
[status-image]: https://cd.screwdriver.cd/pipelines/15/badge
[status-url]: https://cd.screwdriver.cd/pipelines/15
[scm-base-class]: https://github.com/screwdriver-cd/scm-base