https://github.com/screwdriver-cd/scm-github
Github implementation of the scm-base class
https://github.com/screwdriver-cd/scm-github
github
Last synced: 11 months ago
JSON representation
Github implementation of the scm-base class
- Host: GitHub
- URL: https://github.com/screwdriver-cd/scm-github
- Owner: screwdriver-cd
- License: other
- Created: 2016-08-16T18:02:02.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-11-08T17:52:32.000Z (over 1 year ago)
- Last Synced: 2024-11-08T18:36:26.188Z (over 1 year ago)
- Topics: github
- Language: JavaScript
- Homepage: https://cd.screwdriver.cd/pipelines/8
- Size: 601 KB
- Stars: 2
- Watchers: 22
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# scm-github
[![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], and provides methods to fetch and update data in github.
## Usage
```bash
npm install screwdriver-scm-github
```
### Initialization
The class has a variety of knobs to tweak when interacting with GitHub.
| Parameter | Type | Default | Description |
| :------------- | :---- | :-------------| :-------------|
| config | Object | | Configuration Object |
| config.gheHost | String | null | If using GitHub Enterprise, the host/port of the deployed instance |
| config.gheProtocol | String | https | If using GitHub Enterprise, the protocol to use |
| config.username | String | sd-buildbot | GitHub username for checkout |
| config.email | String | dev-null@screwdriver.cd | GitHub user email for checkout |
| config.https | Boolean | false | Is the Screwdriver API running over HTTPS |
| config.oauthClientId | String | | OAuth Client ID provided by GitHub application |
| config.oauthClientSecret | String | | OAuth Client Secret provided by GitHub application |
| config.readOnly | Object | {} | Config with readOnly info: enabled, username, accessToken, cloneType |
| config.fusebox | Object | {} | [Circuit Breaker configuration][circuitbreaker] |
| config.secret | String | | Secret to validate the signature of webhook events |
| config.privateRepo | Boolean | false | Request 'repo' scope, which allows read/write access for public & private repos
| config.gheCloud | Boolean | false | Flag set to true if using Github Enterprise Cloud |
| [config.gheCloudSlug] | String | null | The Github Enterprise Cloud Slug |
| [config.gheCloudCookie] | String| null | The Github Enterprise Cloud Cookie name |
| [config.gheCloudContext] | String | null | The Github Enterprise Cloud scm context |
| config.githubGraphQLUrl | String | https://api.github.com/graphql | GraphQL endpoint for GitHub |
```js
const scm = new GithubScm({
oauthClientId: 'abcdef',
oauthClientSecret: 'hijklm',
secret: 'somesecret'
});
```
### Methods
#### getScmContexts
No parameters are required.
##### Expected Outcome
A single element array of ScmContext(ex: `['github:github.com']`(default), `['github:github.screwdriver.cd']`), which will be a unique identifier for the scm.
For more information on the exposed methods please see the [scm-base].
## 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-github.svg
[npm-url]: https://npmjs.org/package/screwdriver-scm-github
[downloads-image]: https://img.shields.io/npm/dt/screwdriver-scm-github.svg
[license-image]: https://img.shields.io/npm/l/screwdriver-scm-github.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/8/badge
[status-url]: https://cd.screwdriver.cd/pipelines/8
[scm-base]: https://github.com/screwdriver-cd/scm-base