https://github.com/envato/stop-the-line-buildkite-plugin

Stop Buildkite pipelines based on build meta-data values.
https://github.com/envato/stop-the-line-buildkite-plugin

buildkite-plugin

Last synced: 6 months ago
JSON representation

Stop Buildkite pipelines based on build meta-data values.

• Host: GitHub
• URL: https://github.com/envato/stop-the-line-buildkite-plugin
• Owner: envato
• License: mit
• Created: 2018-11-26T13:35:08.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2022-02-07T00:17:46.000Z (over 3 years ago)
• Last Synced: 2025-04-02T12:45:28.080Z (6 months ago)
• Topics: buildkite-plugin
• Language: Shell
• Size: 9.77 KB
• Stars: 5
• Watchers: 64
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Stop The Line Buildkite Plugin

[![tests](https://github.com/envato/stop-the-line-buildkite-plugin/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/envato/stop-the-line-buildkite-plugin/actions/workflows/tests.yml)

[![MIT License](https://img.shields.io/badge/License-MIT-brightgreen.svg)](LICENSE)

A [Buildkite plugin] that stops build if a metadata key has a certain value.

## Example

```yml

steps:

  - label: ":octagonal_sign:"

    plugins:

      - envato/stop-the-line#v0.1.0:

          if:

            key: "no-more-work"

            value: "true"

          style: "pass"

```

```yml

steps:

  - label: ":octagonal_sign:"

    plugins:

      - envato/stop-the-line#v0.1.0:

          unless:

            key: "sky"

            value: "blue"

          style: "fail"

```

## Development

To run the tests:

```sh

docker-compose run --rm tests

```

To run the [Buildkite Plugin Linter]:

```sh

docker-compose run --rm lint

```

[Buildkite Plugin]: https://buildkite.com/docs/agent/v3/plugins

[Buildkite Plugin Linter]: https://github.com/buildkite-plugins/buildkite-plugin-linter