https://github.com/nib-health-funds/node-buildkite-inline-image
Provides an easy method for outputting inline images in the buildkite output log.
https://github.com/nib-health-funds/node-buildkite-inline-image
buildkite buildkite-inline-image inline-images
Last synced: 13 days ago
JSON representation
Provides an easy method for outputting inline images in the buildkite output log.
- Host: GitHub
- URL: https://github.com/nib-health-funds/node-buildkite-inline-image
- Owner: nib-health-funds
- Created: 2017-01-25T06:39:01.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-01-27T02:58:57.000Z (over 8 years ago)
- Last Synced: 2025-08-08T20:00:22.862Z (2 months ago)
- Topics: buildkite, buildkite-inline-image, inline-images
- Language: JavaScript
- Homepage:
- Size: 102 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @nib/buildkite-inline-image
Provides an easy way to output inline images into your buildkite output log from node.
Handles generating the correct ANSI control characters and buildkite inline image syntax.
Read more at the buildkite docs [here](https://buildkite.com/docs/builds/images-in-log-output).
## Usage
```javascript
var buildkiteInlineImage = require('@nib/buildkite-inline-image');
// Inline image from url
var inlineImage = buildkiteInlineImage.inlineURLImage('https://github.com/nib-health-funds/node-buildkite-inline-image/blob/master/docs/inline_image_example.png');
console.log(inlineImage);
// Or, from an uploaded artifact
var artifactFilePath = '/path/to/artifact.png';
var inlineArtifactImage = buildkiteInlineImage.inlineArtifactImage(artifactFilePath);
console.log(inlineArtifactImage);
```
The above would result in something similiar to the following output:
