Skip to content

A Pulumi provider for interacting with the Buildkite CI/CD service

License

Notifications You must be signed in to change notification settings

pulumiverse/pulumi-buildkite

Repository files navigation

Buildkite Resource Provider

The Buildkite Resource Provider lets you manage Buildkite resources.

The provider is built on https://github.com/buildkite/terraform-provider-buildkite.

Installing

Important

The provider version v2.3.1 was built on the Terraform provider v0.25.1 which was a pre-release version. From v3.0.0 onwards this provider is compatible with the Terraform provider v1.x.x. Please note that backwards compatibility might not be given.

This package is available in many languages in the standard packaging formats.

Node.js (JavaScript/TypeScript)

To use from JavaScript or TypeScript in Node.js, install using either npm:

npm install @pulumiverse/buildkite

or yarn:

yarn add @pulumiverse/buildkite

Python

To use from Python, install using pip:

pip install pulumiverse-buildkite

Go

To use from Go, use go get to grab the latest version of the library:

go get github.com/pulumiverse/pulumi-buildkite/sdk/go/...

.NET

To use from .NET, install using dotnet add package:

dotnet add package Pulumiverse.Buildkite

Configuration

The following configuration points are available for the buildkite provider:

  • buildkite:api_token (required, environment: BUILDKITE_API_TOKEN) - A Buildkite API Access Token. Must have GraphQL access, as well as the write_pipelines and read_pipelines scopes.
  • buildkite:organization (required, environment: BUILDKITE_ORGANIZATION) - The Buildkite organization slug.
  • buildkite:graphql_url (optional, environment: BUILDKITE_GRAPHQL_URL) - The Buildkite GraphQL URL.
  • buildkite:rest_url (optional, environment: BUILDKITE_REST_URL) - The Buildkite REST URL.

Example

Example for Typescript to create a resource:

import * as buildkite from '@pulumiverse/buildkite';

const args = {};
const vm = new buildkite.agent.AgentToken(
  'token',
  args,
);

Reference

For detailed reference documentation, please visit the upstream Terraform provider's documentation at: https://registry.terraform.io/providers/buildkite/buildkite/latest

Contributors

Thanks goes to these wonderful people (emoji key):

Daniel Mühlbachler-Pietrzykowski
Daniel Mühlbachler-Pietrzykowski

🚧 💻 📖
Christopher Maier
Christopher Maier

💻 📖
Susan Evans
Susan Evans

📖
Paul Stack
Paul Stack

📖

This project follows the all-contributors specification. Contributions of any kind welcome!