Skip to content

s-yoshika/queue-worker

 
 

Repository files navigation

Screwdriver Executor Queue Worker

Version Downloads Build Status Open Issues Dependency Status License

Create executor queue worker(s)

A Resque Worker implementation that consumes jobs in a Resque queue.

Usage

npm install screwdriver-queue-worker

Methods

Start

Required Parameters
Parameter Type Description
config Object Configuration Object
config.annotations Object Optional key-value object
config.apiUri String Screwdriver's API
config.buildId String The unique ID for a build
config.container String Container for the build to run in
config.token String JWT to act on behalf of the build
Expected Outcome

The start function is expected to create a build in the designated execution engine.

Expected Return

A callback of fn(err, result), where err is an Error that was encountered (if any) and result is the data that the execution engine returns.

Stop

Required Parameters
Parameter Type Description
config Object Configuration Object
config.annotations Object Optional key-value object
config.buildId String The unique ID for a build
Expected Outcome

The stop function is expected to stop/cleanup a task in the desginated execution engine.

Expected Return

A callback of fn(err, result), where err is an Error that was encountered (if any) and result is the data that the execution engine returns.

Testing

npm test

License

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

About

Create executor queue worker(s)

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%