Class GitHubTargetsParams

Base parameters for working with GitHub repo(s). Allows use of regex.

Hierarchy

TargetsParams
- GitHubTargetsParams

Implements

Index

Properties

Accessors

Methods

test

Properties

apiUrl

apiUrl: string

Abstract branch

branch: string

Private Readonly githubToken

githubToken: string

Abstract owner

owner: string

Abstract repo

repo: string

Repo name. May be a repo name or a string containing a regular expression.

Abstract sha

sha: string

Accessors

credentials

get credentials(): ProjectOperationCredentials

Overrides TargetsParams.credentials
- Defined in lib/operations/common/params/GitHubTargetsParams.ts:22
Returns ProjectOperationCredentials

repoRef

get repoRef(): GitHubRepoRef

Overrides TargetsParams.repoRef
- Defined in lib/operations/common/params/GitHubTargetsParams.ts:34
Return a single RepoRef or undefined if we're not identifying a single repo

Returns GitHubRepoRef

usesRegex

get usesRegex(): boolean

Inherited from TargetsParams.usesRegex
- Defined in lib/operations/common/params/TargetsParams.ts:30
Returns boolean

Methods

test

test(rr: RepoId): boolean

Inherited from TargetsParams.test
- Defined in lib/operations/common/params/TargetsParams.ts:41
If we're not tied to a single repo ref, test this RepoRef

Parameters
- rr: RepoId
Returns boolean

Generated using TypeDoc