Class Project

Not fully implemented yet. Fetch project pipeline parameters from inside a CircleCI job.

alpha

Hierarchy

Project

Index

Constructors

constructor

Properties

_isLocal

Accessors

Constructors

constructor

new Project(isLocal: boolean): Project

- Defined in src/lib/Config/Pipeline/Project.ts:9
Parameters
- isLocal: boolean
Returns Project

Properties

Private _isLocal

_isLocal: boolean

Accessors

git_url

get git_url(): string

- Defined in src/lib/Config/Pipeline/Project.ts:15
The URL where the current project is hosted. E.g. https://github.com/circleci/circleci-docs

Returns string

vcs

get vcs(): VCSLiteral

- Defined in src/lib/Config/Pipeline/Project.ts:26
The lower-case name of the VCS provider, E.g. “github”, “bitbucket”

Returns VCSLiteral

Generated using TypeDoc