1. Resources
  2. /
  3. Plugins
  4. /
  5. harness-deploy-buildkite-plugin

Harness Deploy Buildkite Plugin

GitHub Release

A Buildkite plugin to kick off Harness pipelines using the Harness GraphQL API.

Setup

You will need a Harness API key provisioned, as well as input names and their values that are required to start the Harness pipeline. The Harness docs have more information on how to discover and enumerate required execution and service inputs for a given pipeline.

Example

The following Buildkite pipeline will start the production-app Harness pipeline in the app Harness application. Execution inputs and service inputs will depoend on your Harness pipeline setup, but included are some examples.

  - name: "Start Harness deploy"
    command: 'echo "Starting harness deploy for ''\$ENV'' and commit hash ''\$APP_COMMIT_HASH''"'
    plugins:
      - campspot/harness-deploy#v1.0.0:
          application: "app"
          pipeline: "production-app"
          harness-api-key: ${API_KEY}
          harness-account-id: ${ACCOUNT_ID}
          inputs:
            - name: "env"
              value: "app-${ENV}"
            - name: "commit_hash"
              value: "$APP_COMMIT_HASH"
            - name: "infra_one"
              value: "app-${ENV}-infra-one"
            - name: "infra_two"
              value: "app-${ENV}-infra-two"
          services:
            - name: "app-service-one-name"
              artifact: "app-service-one-artifact-name"
              build: "app-service-one-artifact-build-number"
            - name: "app-service-two-name"
              artifact: "app-service-two-artifact-name"
              build: "app-service-two-artifact-build-number"

Configuration

  • application (required, string)

    Name of the Harness application containing the pipeline you wish to kickoff

  • pipeline (required, string)

    Name of the Harness pipeline you wish to kickoff

  • harness-api-key (required, string)

    Your Harness API key used to access the Harness GraphQL API

  • harness-account-id (required, string)

    Your Harness account ID

  • wait-for-deploy (boolean)

    Defaults to true. Whether to wait for the Harness deploy to pass/fail

  • inputs (array)

    Execution inputs that your Harness pipeline requires. Name and value depend on your harness pipeline setup

    • name (string)

    The name of the execution input

    • value (string)

    The value of the execution input

  • services (array)

    Service inputs that your Harness pipeline requires. Values depend on your harness pipeline setup. See Harness docs for more information

    • name (string)

    The name of the service

    • artifact (string)

    The name of the artifact

    • build (string)

    The build number of the artifact

License

MIT (see LICENSE)

The plugins listed on this webpage are provided for informational purposes only. They have not undergone any formal security review or assessment. While we strive to provide useful resources, we cannot guarantee the safety, reliability, or integrity of these plugins. Users are strongly advised to conduct their own security evaluations before downloading, installing, or using any plugin. By using these plugins, you acknowledge and accept any risks associated with their use. We disclaim any liability for any harm or damages arising from the use of the plugins listed.

Start turning complexity into an advantage

Create an account to get started with a 30-day free trial. No credit card required.

Buildkite Pipelines

Platform

  1. Pipelines
  2. Pipeline templates
  3. Public pipelines
  4. Test Engine
  5. Package Registries
  6. Mobile Delivery Cloud
  7. Pricing

Hosting options

  1. Self-hosted agents
  2. Mac hosted agents
  3. Linux hosted agents

Resources

  1. Docs
  2. Blog
  3. Changelog
  4. Webinars
  5. Plugins
  6. Case studies
  7. Events
  8. Migration Services
  9. Comparisons

Company

  1. About
  2. Careers
  3. Press
  4. Brand assets
  5. Contact

Solutions

  1. Replace Jenkins
  2. Workflows for AI/ML
  3. Testing at scale
  4. Monorepo mojo
  5. Bazel orchestration

Legal

  1. Terms of Service
  2. Acceptable Use Policy
  3. Privacy Policy
  4. Subprocessors
  5. Service Level Agreement

Support

  1. System status
  2. Forum
© Buildkite Pty Ltd 2025