buildkite-agent-node

buildkite-agent for Node.js

Access Buildkite agent commands from Node.js

The buildkite-agent binary has 2 roles: running builds and communicating additional information (Annotations, artifacts, ...) from a build to the agent running the build.

This project target is to provide access to the second set of commands from Node.js without needing the agent binary.

Supported features

The library is currently in development without any stable release and only a small subset of the agent commands is implemented.

• annotate
• artifact
• meta-data
• pipeline
  • Interpolation

Examples

Adding an annotation:

import { annotate, AnnotationStyle } from 'buildkite-agent-node';
 
annotate('Hello world 👋!', {
    context: 'example',
    style: AnnotationStyle.Success
});

Users

• jest-buildkite-reporter Report Jest test results to Buildkite as annotations.

License

This project is using the MIT license.