Giter Club home page Giter Club logo

annotate-from-file-buildkite-plugin's Introduction

Annotate From File Buildkite Plugin

Annotates the build with the contents of a file

This is intended to be used with other plugins like docker-compose.

Example

Add the following to your pipeline.yml:

steps:
  - command: ls > /app/output/output.md
    plugins:
      - docker-compose#v3.7.0:
          run: app
          volumes:
            - "./output:/app/output"
      - phcyso/annotate-from-file#v1.0.0:
          path: './output/output.md'

Configuration

path (Required, string)

The path to the file to show as an annotation.

must_exist (Optional, boolean, default: false)

If must_exist is set to true then the plugin will exit non zero if the files given in path does not exist

style (Optional, string, default: "info")

One of the allowed annotation styles

Developing

To run the tests:

docker-compose run --rm tests

Contributing

  1. Fork the repo
  2. Make the changes
  3. Run the tests
  4. Commit and push your changes
  5. Send a pull request

annotate-from-file-buildkite-plugin's People

Contributors

phcyso avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.