-
Notifications
You must be signed in to change notification settings - Fork 0
Class.Resource
@decentm/concourse-ts / Resource
Defined in: components/resource.ts:32
A resource is an external entity that can be checked, fetched (get), and pushed (put). Resources are versioned and can trigger jobs when new versions are detected.
https://concourse-ci.org/docs/resources/
• Source extends Config = Config
• PutParams extends Config = Config
• GetParams extends Config = Config
• ResourceTypeType extends string = string
• ResourceTypeConfig extends Config = Config
new Resource<
Source,PutParams,GetParams,ResourceTypeType,ResourceTypeConfig>(name,type,customise?):Resource<Source,PutParams,GetParams,ResourceTypeType,ResourceTypeConfig>
Defined in: components/resource.ts:148
string
ResourceType<ResourceTypeType, ResourceTypeConfig>
(instance) => void
Resource<Source, PutParams, GetParams, ResourceTypeType, ResourceTypeConfig>
add_tags(...
tags):void
Defined in: components/resource.ts:249
Adds tags to specify which workers should run the resource's check, get, and put operations.
https://concourse-ci.org/docs/resources/#resource-schema
...string[]
Worker tags
void
as_get_step(
input?,customise?):GetStep<Source,PutParams,GetParams>
Defined in: components/resource.ts:332
Creates a GetStep for fetching this resource. The step can be added to a job's plan.
https://concourse-ci.org/docs/steps/get/
AsGetStepInput<GetParams>
Optional params, passed jobs, and trigger flag
(instance) => void
Optional customiser for the created step
GetStep<Source, PutParams, GetParams>
A configured GetStep for this resource
as_put_step(
input?,customise?):PutStep<Source,PutParams,GetParams>
Defined in: components/resource.ts:293
Creates a PutStep for pushing to this resource. The step can be added to a job's plan.
https://concourse-ci.org/docs/steps/put/
AsPutStepInput<PutParams>
Optional params and inputs for the put
(instance) => void
Optional customiser for the created step
PutStep<Source, PutParams, GetParams>
A configured PutStep for this resource
customise_get_step(
init):void
Defined in: components/resource.ts:106
Customises GetSteps created from this specific Resource instance's as_get_step method.
(instance, parent) => void
Customiser function receiving the GetStep and this Resource
void
customise_put_step(
init):void
Defined in: components/resource.ts:125
Customises PutSteps created from this specific Resource instance's as_put_step method.
(instance, parent) => void
Customiser function receiving the PutStep and this Resource
void
set_check_every(
input):void
Defined in: components/resource.ts:201
Sets how frequently to check for new versions of the resource. Use 'never' to disable automatic checking.
https://concourse-ci.org/docs/resources/#resource-schema
Duration between checks
DurationInput | "never"
void
set_icon(
icon):void
Defined in: components/resource.ts:215
Sets the Material Design icon to display for this resource in the UI. See https://pictogrammers.com/library/mdi/ for available icons.
https://concourse-ci.org/docs/resources/#resource-schema
string
The icon name (e.g., 'git', 'docker')
void
set_name(
name):void
Defined in: components/resource.ts:144
Sets the name of the resource. The name is used to reference the resource in jobs and steps.
https://concourse-ci.org/docs/resources/#resource-schema
string
The resource name
void
set_old_name(
old_name):void
Defined in: components/resource.ts:224
https://concourse-ci.org/docs/resources/#resource-schema
string
void
set_public():
void
Defined in: components/resource.ts:235
Sets "public" to true - avoid calling to keep false
https://concourse-ci.org/docs/resources/#resource-schema
void
set_source(
source):void
Defined in: components/resource.ts:187
https://concourse-ci.org/docs/resources/#resource-schema
Source
void
set_version(
version):void
Defined in: components/resource.ts:265
Pins the resource to a specific version. When set, only this version will be used unless explicitly unpinned.
https://concourse-ci.org/docs/resources/#resource-schema
The version to pin to
void
set_webhook_token(
webhook_token):void
Defined in: components/resource.ts:279
Sets a token for webhook-triggered checking. When set, external systems can notify Concourse of new versions via webhook.
https://concourse-ci.org/docs/resources/#resource-schema
string
The webhook token
void
staticcustomise(init):void
Defined in: components/resource.ts:48
Customises all Resources constructed after calling this function.
(instance) => void
void
staticcustomise_get_step<Source,PutParams,GetParams>(init):void
Defined in: components/resource.ts:61
Customises all GetSteps created from any Resource's as_get_step method.
• Source extends Config = Config
• PutParams extends Config = Config
• GetParams extends Config = Config
(instance, parent) => void
Customiser function receiving the GetStep and the Resource it was created from
void
staticcustomise_put_step<Source,PutParams,GetParams>(init):void
Defined in: components/resource.ts:83
Customises all PutSteps created from any Resource's as_put_step method.
• Source extends Config = Config
• PutParams extends Config = Config
• GetParams extends Config = Config
(instance, parent) => void
Customiser function receiving the PutStep and the Resource it was created from
void