Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 1.17 KB

README.md

File metadata and controls

57 lines (38 loc) · 1.17 KB
Raw

Branch Commit Buildkite Plugin

A Buildkite plugin to check that the build commit is on the set branch

Options

These are all the options available to configure this plugin's behaviour.

Required

mode (string)

This can be either warn or strict.

  • warn will output a warning that the current set BUILDKITE_BRANCH is not where the build commit is located but continue the build
  • strict will fail the build in the above scenario

Examples

In warn mode:

steps:
  - label: ":pipeline:"
    command: buildkite-agent pipeline upload
    plugins:
      - branch-commit:
          mode: "warn"

In strict mode:

steps:
  steps:
    - label: ":pipeline:"
      command: buildkite-agent pipeline upload
      plugins:
        - branch-commit:
            mode: "strict"

⚒ Developing

You can use the bk cli to run the pipeline locally:

bk local run

👩‍💻 Contributing

Your policy on how to contribute to the plugin!

📜 License

The package is available as open source under the terms of the MIT License.