Skip to content

Commit b510059

Browse files
wahapominzcmu
wahapo
authored and
minzcmu
committed
feat(365): scm-router first commit. BREAKING CHANGE: bump major
1 parent 456d54f commit b510059

File tree

14 files changed

+1463
-1
lines changed

14 files changed

+1463
-1
lines changed

‎.editorconfig‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 4
6+
end_of_line = lf
7+
charset = utf-8
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true
10+
11+
[*.md]
12+
trim_trailing_whitespace = false

‎.eslintignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules/
2+
artifacts/
3+
features/*.feature

‎.eslintrc.yaml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
extends: screwdriver
2+
rules:
3+
no-console: off

‎.gitignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
node_modules/
2+
artifacts/
3+
npm-debug.log
4+
.DS_STORE
5+
.*.swp
6+
.nyc_output/

‎.npmignore‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
ci/
2+
.editorconfig
3+
eslint*
4+
CONTRIBUTING.md
5+
screwdriver.yaml
6+
test/
7+
features/

‎CONTRIBUTING.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Contributing to Screwdriver
2+
3+
Have a look at our guidelines, as well as pointers on where to start making changes, in our official [documentation](http://docs.screwdriver.cd/about/contributing).
4+

‎LICENSE‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Copyright 2017 Yahoo Inc.
2+
All rights reserved.
3+
4+
Redistribution and use in source and binary forms, with or without
5+
modification, are permitted provided that the following conditions are met:
6+
* Redistributions of source code must retain the above copyright
7+
notice, this list of conditions and the following disclaimer.
8+
* Redistributions in binary form must reproduce the above copyright
9+
notice, this list of conditions and the following disclaimer in the
10+
documentation and/or other materials provided with the distribution.
11+
* Neither the name of the Yahoo! Inc. nor the
12+
names of its contributors may be used to endorse or promote products
13+
derived from this software without specific prior written permission.
14+
15+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18+
DISCLAIMED. IN NO EVENT SHALL YAHOO! INC. BE LIABLE FOR ANY
19+
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22+
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎README.md‎

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,56 @@
1-
# scm-router
1+
# SCM Router
2+
[![Version][npm-image]][npm-url] ![Downloads][downloads-image] [![Build Status][status-image]][status-url] [![Open Issues][issues-image]][issues-url] [![Dependency Status][daviddm-image]][daviddm-url] ![License][license-image]
3+
4+
> A generic scm plugin that routes builds to a specified scm
5+
6+
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.
7+
8+
i.e. Github, Bitbucket, Gitlab
9+
10+
The scm router will allow multiple scms to be used in a Screwdriver cluster.
11+
12+
## Usage
13+
14+
```bash
15+
npm install screwdriver-scm-router
16+
```
17+
18+
### Interface
19+
20+
It will initialize any routers specified in the [default.yaml](https://github.com/screwdriver-cd/screwdriver/blob/master/config/default.yaml#L123-L156) under the `scms` keyword.
21+
22+
**Example scm yaml section:**
23+
```
24+
scms:
25+
githubDisplayName:
26+
plugin: github
27+
config:
28+
oauthClientId: YOU-PROBABLY-WANT-SOMETHING-HERE
29+
......
30+
bitbucketDisplayName:
31+
plugin: bitbucket
32+
config:
33+
oauthClientId: YOUR-BITBUCKET-OAUTH-CLIENT-ID
34+
......
35+
```
36+
37+
## Testing
38+
39+
```bash
40+
npm test
41+
```
42+
43+
## License
44+
45+
Code licensed under the BSD 3-Clause license. See LICENSE file for terms.
46+
47+
[npm-image]: https://img.shields.io/npm/v/screwdriver-scm-router.svg
48+
[npm-url]: https://npmjs.org/package/screwdriver-scm-router
49+
[downloads-image]: https://img.shields.io/npm/dt/screwdriver-scm-router.svg
50+
[license-image]: https://img.shields.io/npm/l/screwdriver-scm-router.svg
51+
[issues-image]: https://img.shields.io/github/issues/screwdriver-cd/scm-router.svg
52+
[issues-url]: https://github.com/screwdriver-cd/scm-router/issues
53+
[status-image]: https://cd.screwdriver.cd/pipelines/275/badge
54+
[status-url]: https://cd.screwdriver.cd/pipelines/275
55+
[daviddm-image]: https://david-dm.org/screwdriver-cd/scm-router.svg?theme=shields.io
56+
[daviddm-url]: https://david-dm.org/screwdriver-cd/scm-router

0 commit comments

Comments
 (0)