new Job({
id: "github-integration-on-issue",
name: "GitHub Integration - On Issue",
version: "0.1.0",
trigger: github.triggers.repo({
event: events.onIssue,
owner: "triggerdotdev",
repo: "empty",
}),
run: async (payload, io, ctx) => {
await io.logger.info("This is a simple log info message");
return { payload, ctx };
},
}).attachToClient(client);
Job is used to create and configure a Job
new Job({
id: "github-integration-on-issue",
name: "GitHub Integration - On Issue",
version: "0.1.0",
trigger: github.triggers.repo({
event: events.onIssue,
owner: "triggerdotdev",
repo: "empty",
}),
run: async (payload, io, ctx) => {
await io.logger.info("This is a simple log info message");
return { payload, ctx };
},
}).attachToClient(client);
TriggerClient.defineJob
instance method:
new Job({
id: "github-integration-on-issue",
name: "GitHub Integration - On Issue",
version: "0.1.0",
trigger: github.triggers.repo({
event: events.onIssue,
owner: "triggerdotdev",
repo: "empty",
}),
run: async (payload, io, ctx) => {
await io.logger.info("This is a simple log info message");
return { payload, ctx };
},
}).attachToClient(client);
Hide properties
id
property is used to uniquely identify the Job. Only change this if you want to create a new Job.name
of the Job that you want to appear in the dashboard and logs. You can change this without creating a new Job.version
property is used to version your Job. A new version will be created if you change this property. We recommend using semantic versioning, e.g. 1.0.3
.trigger
property is used to define when the Job should run. There are currently the following Trigger types:payload
– The payload that was sent to the Trigger API.integrations
property and other useful functions like delays and running Tasks.io
object in the run()
function with the same name as the key. For example:client.defineJob({
//... other options
integrations: {
slack,
gh: github,
},
run: async (payload, io, ctx) => {
//slack is available on io.slack
io.slack.postMessage(...);
//github is available on io.gh
io.gh.addIssueLabels(...);
}
});
enabled
property is an optional property that specifies whether the Job is enabled or not. The Job will be enabled by default if you omit this property. When a job is disabled, no new runs will be triggered or resumed. In progress runs will continue to run until they are finished or delayed by using io.wait
.concurrencyLimit
property is an optional property that specifies the maximum number of concurrent run executions. If this property is omitted, the job can potentially use up the full concurrency of an environment. You can also create a limit on a group of jobs by defining a ConcurrencyLimit object.onSuccess
property is an optional property that specifies a callback function to run when the Job finishes successfully. The callback function receives a Run Notification object as it's only parameter.onFailure
property is an optional property that specifies a callback function to run when the Job fails to complete successfully. The callback function receives a Run Notification object as it's only parameter.logLevel
property is an optional property that specifies the level of
logging for the Job. The level is inherited from the client if you omit this property.log
- logs only essential messageserror
- logs error messageswarn
- logs errors and warning messagesinfo
- logs errors, warnings and info messagesdebug
- logs everything with full verbosityWas this page helpful?