14.1.0 • Published 4 months ago

screwdriver-scm-github v14.1.0

Weekly downloads
51
License
BSD-3-Clause
Repository
github
Last release
4 months ago

scm-github

Version Downloads Build Status Open Issues License

This scm plugin extends the scm-base, and provides methods to fetch and update data in github.

Usage

npm install screwdriver-scm-github

Initialization

The class has a variety of knobs to tweak when interacting with GitHub.

ParameterTypeDefaultDescription
configObjectConfiguration Object
config.gheHostStringnullIf using GitHub Enterprise, the host/port of the deployed instance
config.gheProtocolStringhttpsIf using GitHub Enterprise, the protocol to use
config.usernameStringsd-buildbotGitHub username for checkout
config.emailStringdev-null@screwdriver.cdGitHub user email for checkout
config.httpsBooleanfalseIs the Screwdriver API running over HTTPS
config.oauthClientIdStringOAuth Client ID provided by GitHub application
config.oauthClientSecretStringOAuth Client Secret provided by GitHub application
config.readOnlyObject{}Config with readOnly info: enabled, username, accessToken, cloneType
config.fuseboxObject{}Circuit Breaker configuration
config.secretStringSecret to validate the signature of webhook events
config.privateRepoBooleanfalseRequest 'repo' scope, which allows read/write access for public & private repos
config.gheCloudBooleanfalseFlag set to true if using Github Enterprise Cloud
config.gheCloudSlugStringnullThe Github Enterprise Cloud Slug
config.gheCloudCookieStringnullThe Github Enterprise Cloud Cookie name
config.gheCloudContextStringnullThe Github Enterprise Cloud scm context
config.githubGraphQLUrlStringhttps://api.github.com/graphqlGraphQL endpoint for GitHub
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

npm test

License

Code licensed under the BSD 3-Clause license. See LICENSE file for terms.

14.1.0

4 months ago

13.2.0

8 months ago

14.0.0

4 months ago

13.1.1

9 months ago

13.1.0

9 months ago

13.0.0

10 months ago

12.9.1

10 months ago

12.8.0

12 months ago

12.8.1

12 months ago

12.7.0

1 year ago

12.7.1

1 year ago

12.7.2

12 months ago

12.7.3

12 months ago

12.9.0

11 months ago

12.6.0

1 year ago

12.5.0

1 year ago

12.4.0

1 year ago

12.3.0

1 year ago

12.2.6

1 year ago

12.2.5

1 year ago

12.2.2

2 years ago

12.2.3

2 years ago

12.2.4

2 years ago

12.2.1

2 years ago

12.2.0

2 years ago

12.1.1

2 years ago

12.1.0

2 years ago

12.0.0

3 years ago

12.0.1

2 years ago

11.10.2

3 years ago

11.10.3

3 years ago

11.10.1

3 years ago

11.10.0

3 years ago

11.9.1

3 years ago

11.9.0

3 years ago

11.8.2

3 years ago

11.8.3

3 years ago

11.8.0

4 years ago

11.8.1

3 years ago

11.7.1

4 years ago

11.6.2

4 years ago

11.6.3

4 years ago

11.7.0

4 years ago

11.6.1

4 years ago

11.6.0

4 years ago

11.5.0

4 years ago

11.4.0

4 years ago

11.3.1

4 years ago

11.3.0

4 years ago

11.2.0

4 years ago

11.1.4

4 years ago

11.1.3

5 years ago

11.1.2

5 years ago

11.1.1

5 years ago

11.1.0

5 years ago

11.0.4

5 years ago

11.0.3

5 years ago

11.0.2

5 years ago

11.0.0

5 years ago

11.0.1

5 years ago

10.3.3

5 years ago

10.3.2

5 years ago

10.3.1

5 years ago

10.3.0

5 years ago

10.2.2

5 years ago

10.2.1

5 years ago

10.2.0

5 years ago

10.1.0

5 years ago

10.0.6

5 years ago

10.0.5

5 years ago

10.0.4

5 years ago

10.0.3

5 years ago

10.0.2

5 years ago

10.0.1

5 years ago

10.0.0

5 years ago

9.6.3

5 years ago

9.6.2

5 years ago

9.6.1

5 years ago

9.5.4

5 years ago

9.6.0

5 years ago

9.5.3

5 years ago

9.5.2

5 years ago

9.5.1

5 years ago

9.5.0

6 years ago

9.4.2

6 years ago

9.4.1

6 years ago

9.4.0

6 years ago

9.3.7

6 years ago

9.3.6

6 years ago

9.3.5

6 years ago

9.3.4

6 years ago

9.3.3

6 years ago

9.3.2

6 years ago

9.3.1

6 years ago

9.3.0

6 years ago

9.2.6

6 years ago

9.2.5

6 years ago

9.2.4

6 years ago

9.2.3

6 years ago

9.2.2

6 years ago

9.2.1

6 years ago

9.2.0

6 years ago

9.1.2

6 years ago

9.1.1

6 years ago

9.1.0

6 years ago

9.0.0

6 years ago

8.5.2

6 years ago

8.5.1

6 years ago

8.5.0

6 years ago

8.4.0

6 years ago

8.3.1

6 years ago

8.3.0

6 years ago

8.2.2

6 years ago

8.2.1

7 years ago

8.2.0

7 years ago

8.1.6

7 years ago

8.1.5

7 years ago

8.1.4

7 years ago

8.1.3

7 years ago

8.1.2

7 years ago

8.1.1

7 years ago

8.1.0

7 years ago

8.0.10

7 years ago

8.0.9

7 years ago

8.0.8

7 years ago

8.0.7

7 years ago

8.0.6

7 years ago

8.0.5

7 years ago

8.0.4

7 years ago

8.0.3

7 years ago

8.0.2

7 years ago

8.0.1

7 years ago

8.0.0

7 years ago

7.4.0

7 years ago

7.3.1

7 years ago

7.3.0

7 years ago

7.2.0

7 years ago

7.1.0

7 years ago

7.0.0

7 years ago

6.0.2

7 years ago

6.0.1

7 years ago

6.0.0

7 years ago

5.3.2

7 years ago

5.3.1

7 years ago

5.3.0

7 years ago

5.2.1

7 years ago

5.2.0

7 years ago

5.1.4

7 years ago

5.1.3

8 years ago

5.1.2

8 years ago

5.1.1

8 years ago

5.1.0

8 years ago

5.0.2

8 years ago

5.0.1

8 years ago

5.0.0

8 years ago

4.9.1

8 years ago

4.9.0

8 years ago

4.8.3

8 years ago

4.8.2

8 years ago

4.8.1

8 years ago

4.8.0

8 years ago

4.7.5

8 years ago

4.7.4

8 years ago

4.7.3

8 years ago

4.7.2

8 years ago

4.7.1

8 years ago

4.7.0

8 years ago

4.6.0

8 years ago

4.5.3

9 years ago

4.5.2

9 years ago

4.5.1

9 years ago

4.5.0

9 years ago

4.4.6

9 years ago

4.4.5

9 years ago

4.4.4

9 years ago

4.4.3

9 years ago

4.4.2

9 years ago

4.4.1

9 years ago

4.4.0

9 years ago

4.3.4

9 years ago

4.3.3

9 years ago

4.3.2

9 years ago

4.3.1

9 years ago

4.3.0

9 years ago

4.2.1

9 years ago

4.2.0

9 years ago

4.1.1

9 years ago

4.1.0

9 years ago

4.0.0

9 years ago

3.1.0

9 years ago

3.0.1

9 years ago

3.0.0

9 years ago

2.0.8

9 years ago

2.0.7

9 years ago

2.0.6

9 years ago

2.0.5

9 years ago

2.0.4

9 years ago

2.0.3

9 years ago

2.0.2

9 years ago

2.0.1

9 years ago

2.0.0

9 years ago

1.1.1

9 years ago

1.1.0

9 years ago

1.0.7

9 years ago

1.0.6

9 years ago

1.0.5

9 years ago

1.0.4

9 years ago

1.0.3

9 years ago

1.0.2

9 years ago

1.0.1

9 years ago

1.0.0

9 years ago

0.0.2

9 years ago

0.0.1

9 years ago