https://github.com/screwdriver-cd/scm-router
Routes builds to a specified scm
https://github.com/screwdriver-cd/scm-router
Last synced: 11 months ago
JSON representation
Routes builds to a specified scm
- Host: GitHub
- URL: https://github.com/screwdriver-cd/scm-router
- Owner: screwdriver-cd
- License: other
- Created: 2017-07-11T01:08:05.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T23:59:46.000Z (over 1 year ago)
- Last Synced: 2024-11-23T02:39:57.774Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://cd.screwdriver.cd/pipelines/275
- Size: 53.7 KB
- Stars: 0
- Watchers: 17
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# SCM Router
[![Version][npm-image]][npm-url] ![Downloads][downloads-image] [![Build Status][status-image]][status-url] [![Open Issues][issues-image]][issues-url] ![License][license-image]
> A generic scm plugin that routes builds to a specified scm
An SCM is a source control management system, like Github, Bitbucket, Gitlab, etc. This SCM Router module will allow multiple SCMs to be used within a single Screwdriver cluster.
i.e. Github, Bitbucket, Gitlab
The scm router will allow multiple scms to be used in a Screwdriver cluster.
## Usage
```bash
npm install screwdriver-scm-router
```
### Interface
It will initialize any routers specified in the [default.yaml](https://github.com/screwdriver-cd/screwdriver/blob/master/config/default.yaml#L147-L185) under the `scms` keyword.
**Example scm yaml section:**
```
scms:
githubDisplayName:
plugin: github
config:
oauthClientId: YOU-PROBABLY-WANT-SOMETHING-HERE
......
bitbucketDisplayName:
plugin: bitbucket
config:
oauthClientId: YOUR-BITBUCKET-OAUTH-CLIENT-ID
......
```
## 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-router.svg
[npm-url]: https://npmjs.org/package/screwdriver-scm-router
[downloads-image]: https://img.shields.io/npm/dt/screwdriver-scm-router.svg
[license-image]: https://img.shields.io/npm/l/screwdriver-scm-router.svg
[issues-image]: https://img.shields.io/github/issues/screwdriver-cd/scm-router.svg
[issues-url]: https://github.com/screwdriver-cd/scm-router/issues
[status-image]: https://cd.screwdriver.cd/pipelines/275/badge
[status-url]: https://cd.screwdriver.cd/pipelines/275