buildkite-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b6f6f72e11f8e14d2d9733ff117a82636b4acb0e328944a4ebdae19155c5aa9
+  data.tar.gz: 52b20845627a68c2c3cc537f2cf56ebd591e8b0272e89bea44a8f0360d30b128
+SHA512:
+  metadata.gz: 5aad164d05ab9412ad990e592408975a40ad3ef859b779e6b90ac15f54c0946a19ec676e123fafa5cf6d54a3eaedbc5540d57614ccfce557e668699e9e626555
+  data.tar.gz: 466d0b6c5b5fc8b0abfb7d5177c089a7048f6da5d188c9cf2df69ad3844899b30271fadecdb956af66006ba15d4a5d3198082f1ff1d45097901d3452873f4e05

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,25 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0
+  # Exclude:
+  #   - "lib/schema.rb"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/LineLength:
+  Exclude:
+    - "lib/environment.rb"
+
+Metrics/ModuleLength:
+  Exclude:
+    - "lib/environment.rb"

data/README.md

@@ -0,0 +1,31 @@
+# Buildkite
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/buildkite`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/buildkite.

data/Rakefile

@@ -0,0 +1,22 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+desc "Build the SDK into the dist directory."
+task :build do
+  gemspec = "buildkite.gemspec"
+  target_dir = File.expand_path("../../dist/sdks/ruby", __dir__)
+
+  mkdir_p target_dir
+
+  sh "gem build #{gemspec}"
+  gem_file = Dir.glob("*.gem").max_by { |f| File.mtime(f) }
+  mv gem_file, File.join(target_dir, gem_file)
+
+  puts "Gem built and moved to: #{target_dir}"
+end

data/env.mustache

@@ -0,0 +1,6 @@
+module Environment
+  {{#variables}}
+  {{{comment}}}
+  {{name}} = "{{name}}"
+  {{/variables}}
+end

data/lib/buildkite/version.rb

@@ -0,0 +1,3 @@
+module Buildkite
+  VERSION = "0.0.1".freeze
+end

data/lib/buildkite.rb

@@ -0,0 +1,42 @@
+require_relative "buildkite/version"
+require_relative "environment"
+require "json"
+require "yaml"
+
+module Buildkite
+  class Error < StandardError; end
+
+  # Here is a comment.
+  class Pipeline
+    def initialize
+      @steps = []
+    end
+
+    # Adds a step to the pipeline.
+    #
+    # @param [Buildkite::CommandStep, Buildkite::BlockStep] step
+    #   The step to add, which can be either a CommandStep or a BlockStep.
+    # @return [self]
+    #   Returns the pipeline itself for chaining.
+    #
+    # @example Adding a CommandStep
+    #   command_step = Buildkite::CommandStep.new(label: "Run tests", commands: ["bundle exec rspec"])
+    #   pipeline.add_step(command_step)
+    #
+    # @example Adding a BlockStep
+    #   block_step = Buildkite::BlockStep.new(label: "Manual approval", block: "Deploy to production")
+    #   pipeline.add_step(block_step)
+    def add_step(step)
+      @steps << step
+      self
+    end
+
+    def to_json(*_args)
+      JSON.pretty_generate({ steps: @steps }, indent: "    ")
+    end
+
+    def to_yaml
+      { steps: @steps }.to_yaml
+    end
+  end
+end

data/lib/environment.rb

@@ -0,0 +1,222 @@
+module Environment
+  # Always `true`
+  BUILDKITE = "BUILDKITE".freeze
+  # The agent session token for the job. The variable is read by the agent `artifact` and `meta-data` commands.
+  BUILDKITE_AGENT_ACCESS_TOKEN = "BUILDKITE_AGENT_ACCESS_TOKEN".freeze
+  # The value of the `debug` [agent configuration option](/docs/agent/v3/configuration).
+  BUILDKITE_AGENT_DEBUG = "BUILDKITE_AGENT_DEBUG".freeze
+  # The value of the `disconnect-after-job` [agent configuration option](/docs/agent/v3/configuration).
+  BUILDKITE_AGENT_DISCONNECT_AFTER_JOB = "BUILDKITE_AGENT_DISCONNECT_AFTER_JOB".freeze
+  # The value of the `disconnect-after-idle-timeout` [agent configuration option](/docs/agent/v3/configuration).
+  BUILDKITE_AGENT_DISCONNECT_AFTER_IDLE_TIMEOUT = "BUILDKITE_AGENT_DISCONNECT_AFTER_IDLE_TIMEOUT".freeze
+  # The value of the `endpoint` [agent configuration option](/docs/agent/v3/configuration). This is set as an environment variable by the bootstrap and then read by most of the `buildkite-agent` commands.
+  BUILDKITE_AGENT_ENDPOINT = "BUILDKITE_AGENT_ENDPOINT".freeze
+  # A list of the [experimental agent features](/docs/agent/v3#experimental-features) that are currently enabled. The value can be set using the `--experiment` flag on the [`buildkite-agent start` command](/docs/agent/v3/cli-start#starting-an-agent) or in your [agent configuration file](/docs/agent/v3/configuration).
+  BUILDKITE_AGENT_EXPERIMENT = "BUILDKITE_AGENT_EXPERIMENT".freeze
+  # The value of the `health-check-addr` [agent configuration option](/docs/agent/v3/configuration).
+  BUILDKITE_AGENT_HEALTH_CHECK_ADDR = "BUILDKITE_AGENT_HEALTH_CHECK_ADDR".freeze
+  # The UUID of the agent.
+  BUILDKITE_AGENT_ID = "BUILDKITE_AGENT_ID".freeze
+  # The value of each [agent tag](/docs/agent/v3/cli-start#setting-tags). The tag name is appended to the end of the variable name. They can be set using the `--tags` flag on the `buildkite-agent start` command, or in the [agent configuration file](/docs/agent/v3/configuration). The [Queue tag](/docs/agent/v3/queues) is specifically used for isolating jobs and agents, and appears as the `BUILDKITE_AGENT_META_DATA_QUEUE` environment variable.
+  BUILDKITE_AGENT_META_DATA_ = "BUILDKITE_AGENT_META_DATA_".freeze
+  # The name of the agent that ran the job.
+  BUILDKITE_AGENT_NAME = "BUILDKITE_AGENT_NAME".freeze
+  # The process ID of the agent.
+  BUILDKITE_AGENT_PID = "BUILDKITE_AGENT_PID".freeze
+  # The artifact paths to upload after the job, if any have been specified. The value can be modified by exporting the environment variable in the `environment` or `pre-checkout` hooks.
+  BUILDKITE_ARTIFACT_PATHS = "BUILDKITE_ARTIFACT_PATHS".freeze
+  # The path where artifacts will be uploaded. This variable is read by the `buildkite-agent artifact upload` command, and during the artifact upload phase of [command steps](/docs/pipelines/command-step#command-step-attributes). It can only be set by exporting the environment variable in the `environment`, `pre-checkout` or `pre-command` hooks.
+  BUILDKITE_ARTIFACT_UPLOAD_DESTINATION = "BUILDKITE_ARTIFACT_UPLOAD_DESTINATION".freeze
+  # The path to the directory containing the `buildkite-agent` binary.
+  BUILDKITE_BIN_PATH = "BUILDKITE_BIN_PATH".freeze
+  # The branch being built. Note that for manually triggered builds, this branch is not guaranteed to contain the commit specified by `BUILDKITE_COMMIT`.
+  BUILDKITE_BRANCH = "BUILDKITE_BRANCH".freeze
+  # The path where the agent has checked out your code for this build. This variable is read by the bootstrap when the agent is started, and can only be set by exporting the environment variable in the `environment` or `pre-checkout` hooks.
+  BUILDKITE_BUILD_CHECKOUT_PATH = "BUILDKITE_BUILD_CHECKOUT_PATH".freeze
+  # The name of the user who authored the commit being built. May be **[unverified](#unverified-commits)**. This value can be blank in some situations, including builds manually triggered using API or Buildkite web interface.
+  BUILDKITE_BUILD_AUTHOR = "BUILDKITE_BUILD_AUTHOR".freeze
+  # The notification email of the user who authored the commit being built. May be **[unverified](#unverified-commits)**. This value can be blank in some situations, including builds manually triggered using API or Buildkite web interface.
+  BUILDKITE_BUILD_AUTHOR_EMAIL = "BUILDKITE_BUILD_AUTHOR_EMAIL".freeze
+  # The name of the user who created the build. The value differs depending on how the build was created:
+  #
+  # - **Buildkite dashboard:** Set based on who manually created the build.
+  # - **GitHub webhook:** Set from the  **[unverified](#unverified-commits)** HEAD commit.
+  # - **Webhook:** Set based on which user is attached to the API Key used.
+  BUILDKITE_BUILD_CREATOR = "BUILDKITE_BUILD_CREATOR".freeze
+  # The notification email of the user who created the build. The value differs depending on how the build was created:
+  #
+  # - **Buildkite dashboard:** Set based on who manually created the build.
+  # - **GitHub webhook:** Set from the  **[unverified](#unverified-commits)** HEAD commit.
+  # - **Webhook:** Set based on which user is attached to the API Key used.
+  BUILDKITE_BUILD_CREATOR_EMAIL = "BUILDKITE_BUILD_CREATOR_EMAIL".freeze
+  # A colon separated list of non-private team slugs that the build creator belongs to. The value differs depending on how the build was created:
+  #
+  # - **Buildkite dashboard:** Set based on who manually created the build.
+  # - **GitHub webhook:** Set from the  **[unverified](#unverified-commits)** HEAD commit.
+  # - **Webhook:** Set based on which user is attached to the API Key used.
+  BUILDKITE_BUILD_CREATOR_TEAMS = "BUILDKITE_BUILD_CREATOR_TEAMS".freeze
+  # The UUID of the build.
+  BUILDKITE_BUILD_ID = "BUILDKITE_BUILD_ID".freeze
+  # The build number. This number increases with every build, and is guaranteed to be unique within each pipeline.
+  BUILDKITE_BUILD_NUMBER = "BUILDKITE_BUILD_NUMBER".freeze
+  # The value of the `build-path` [agent configuration option](/docs/agent/v3/configuration).
+  BUILDKITE_BUILD_PATH = "BUILDKITE_BUILD_PATH".freeze
+  # The url for this build on Buildkite.
+  BUILDKITE_BUILD_URL = "BUILDKITE_BUILD_URL".freeze
+  # The value of the `cancel-grace-period` [agent configuration option](/docs/agent/v3/configuration) in seconds.
+  BUILDKITE_CANCEL_GRACE_PERIOD = "BUILDKITE_CANCEL_GRACE_PERIOD".freeze
+  # The value of the `cancel-signal` [agent configuration option](/docs/agent/v3/configuration). The value can be modified by exporting the environment variable in the `environment` or `pre-checkout` hooks.
+  BUILDKITE_CANCEL_SIGNAL = "BUILDKITE_CANCEL_SIGNAL".freeze
+  # Whether the build should perform a clean checkout. The variable is read during the default checkout phase of the bootstrap and can be overridden in `environment` or `pre-checkout` hooks.
+  BUILDKITE_CLEAN_CHECKOUT = "BUILDKITE_CLEAN_CHECKOUT".freeze
+  # The UUID value of the cluster, but only if the build has an associated `cluster_queue`. Otherwise, this environment variable is not set.
+  BUILDKITE_CLUSTER_ID = "BUILDKITE_CLUSTER_ID".freeze
+  # The command that will be run for the job.
+  BUILDKITE_COMMAND = "BUILDKITE_COMMAND".freeze
+  # The opposite of the value of the `no-command-eval` [agent configuration option](/docs/agent/v3/configuration).
+  BUILDKITE_COMMAND_EVAL = "BUILDKITE_COMMAND_EVAL".freeze
+  # The exit code from the last command run in the command hook.
+  BUILDKITE_COMMAND_EXIT_STATUS = "BUILDKITE_COMMAND_EXIT_STATUS".freeze
+  # The git commit object of the build. This is usually a 40-byte hexadecimal SHA-1 hash, but can also be a symbolic name like `HEAD`.
+  BUILDKITE_COMMIT = "BUILDKITE_COMMIT".freeze
+  # The path to the agent config file.
+  BUILDKITE_CONFIG_PATH = "BUILDKITE_CONFIG_PATH".freeze
+  # The path to the file containing the job's environment variables.
+  BUILDKITE_ENV_FILE = "BUILDKITE_ENV_FILE".freeze
+  # The value of the `git-clean-flags` [agent configuration option](/docs/agent/v3/configuration). The value can be modified by exporting the environment variable in the `environment` or `pre-checkout` hooks.
+  BUILDKITE_GIT_CLEAN_FLAGS = "BUILDKITE_GIT_CLEAN_FLAGS".freeze
+  # The value of the `git-clone-flags` [agent configuration option](/docs/agent/v3/configuration). The value can be modified by exporting the environment variable in the `environment` or `pre-checkout` hooks.
+  BUILDKITE_GIT_CLONE_FLAGS = "BUILDKITE_GIT_CLONE_FLAGS".freeze
+  # The opposite of the value of the `no-git-submodules` [agent configuration option](/docs/agent/v3/configuration).
+  BUILDKITE_GIT_SUBMODULES = "BUILDKITE_GIT_SUBMODULES".freeze
+  # The GitHub deployment ID. Only available on builds triggered by a [GitHub Deployment](https://developer.github.com/v3/repos/deployments/).
+  BUILDKITE_GITHUB_DEPLOYMENT_ID = "BUILDKITE_GITHUB_DEPLOYMENT_ID".freeze
+  # The name of the GitHub deployment environment. Only available on builds triggered by a [GitHub Deployment](https://developer.github.com/v3/repos/deployments/).
+  BUILDKITE_GITHUB_DEPLOYMENT_ENVIRONMENT = "BUILDKITE_GITHUB_DEPLOYMENT_ENVIRONMENT".freeze
+  # The name of the GitHub deployment task. Only available on builds triggered by a [GitHub Deployment](https://developer.github.com/v3/repos/deployments/).
+  BUILDKITE_GITHUB_DEPLOYMENT_TASK = "BUILDKITE_GITHUB_DEPLOYMENT_TASK".freeze
+  # The GitHub deployment payload data as serialized JSON. Only available on builds triggered by a [GitHub Deployment](https://developer.github.com/v3/repos/deployments/).
+  BUILDKITE_GITHUB_DEPLOYMENT_PAYLOAD = "BUILDKITE_GITHUB_DEPLOYMENT_PAYLOAD".freeze
+  # The UUID of the [group step](/docs/pipelines/group-step) the job belongs to. This variable is only available if the job belongs to a group step.
+  BUILDKITE_GROUP_ID = "BUILDKITE_GROUP_ID".freeze
+  # The value of the `key` attribute of the [group step](/docs/pipelines/group-step) the job belongs to. This variable is only available if the job belongs to a group step.
+  BUILDKITE_GROUP_KEY = "BUILDKITE_GROUP_KEY".freeze
+  # The label/name of the [group step](/docs/pipelines/group-step) the job belongs to. This variable is only available if the job belongs to a group step.
+  BUILDKITE_GROUP_LABEL = "BUILDKITE_GROUP_LABEL".freeze
+  # The value of the `hooks-path` [agent configuration option](/docs/agent/v3/configuration).
+  BUILDKITE_HOOKS_PATH = "BUILDKITE_HOOKS_PATH".freeze
+  # A list of environment variables that have been set in your pipeline that are protected and will be overridden, used internally to pass data from the bootstrap to the agent.
+  BUILDKITE_IGNORED_ENV = "BUILDKITE_IGNORED_ENV".freeze
+  # The internal UUID Buildkite uses for this job.
+  BUILDKITE_JOB_ID = "BUILDKITE_JOB_ID".freeze
+  # The path to a temporary file containing the logs for this job. Requires enabling the `enable-job-log-tmpfile` [agent configuration option](/docs/agent/v3/configuration).
+  BUILDKITE_JOB_LOG_TMPFILE = "BUILDKITE_JOB_LOG_TMPFILE".freeze
+  # The label/name of the current job.
+  BUILDKITE_LABEL = "BUILDKITE_LABEL".freeze
+  # The exit code of the last hook that ran, used internally by the hooks.
+  BUILDKITE_LAST_HOOK_EXIT_STATUS = "BUILDKITE_LAST_HOOK_EXIT_STATUS".freeze
+  # The opposite of the value of the `no-local-hooks` [agent configuration option](/docs/agent/v3/configuration).
+  BUILDKITE_LOCAL_HOOKS_ENABLED = "BUILDKITE_LOCAL_HOOKS_ENABLED".freeze
+  # The message associated with the build, usually the commit message or the message provided when the build is triggered. The value is empty when a message is not set. For example, when a user triggers a build from the Buildkite dashboard without entering a message, the variable returns an empty value.
+  BUILDKITE_MESSAGE = "BUILDKITE_MESSAGE".freeze
+  # The UUID of the organization.
+  BUILDKITE_ORGANIZATION_ID = "BUILDKITE_ORGANIZATION_ID".freeze
+  # The organization name on Buildkite as used in URLs.
+  BUILDKITE_ORGANIZATION_SLUG = "BUILDKITE_ORGANIZATION_SLUG".freeze
+  # The index of each parallel job created from a parallel build step, starting from 0. For a build step with `parallelism: 5`, the value would be 0, 1, 2, 3, and 4 respectively.
+  BUILDKITE_PARALLEL_JOB = "BUILDKITE_PARALLEL_JOB".freeze
+  # The total number of parallel jobs created from a parallel build step. For a build step with `parallelism: 5`, the value is 5.
+  BUILDKITE_PARALLEL_JOB_COUNT = "BUILDKITE_PARALLEL_JOB_COUNT".freeze
+  # The default branch for this pipeline.
+  BUILDKITE_PIPELINE_DEFAULT_BRANCH = "BUILDKITE_PIPELINE_DEFAULT_BRANCH".freeze
+  # The UUID of the pipeline.
+  BUILDKITE_PIPELINE_ID = "BUILDKITE_PIPELINE_ID".freeze
+  # The displayed pipeline name on Buildkite.
+  BUILDKITE_PIPELINE_NAME = "BUILDKITE_PIPELINE_NAME".freeze
+  # The ID of the source code provider for the pipeline's repository.
+  BUILDKITE_PIPELINE_PROVIDER = "BUILDKITE_PIPELINE_PROVIDER".freeze
+  # The pipeline slug on Buildkite as used in URLs.
+  BUILDKITE_PIPELINE_SLUG = "BUILDKITE_PIPELINE_SLUG".freeze
+  # A colon separated list of the pipeline's non-private team slugs.
+  BUILDKITE_PIPELINE_TEAMS = "BUILDKITE_PIPELINE_TEAMS".freeze
+  # A JSON string holding the current plugin's configuration (as opposed to all the plugin configurations in the `BUILDKITE_PLUGINS` environment variable).
+  BUILDKITE_PLUGIN_CONFIGURATION = "BUILDKITE_PLUGIN_CONFIGURATION".freeze
+  # The current plugin's name, with all letters in uppercase and any spaces replaced with underscores.
+  BUILDKITE_PLUGIN_NAME = "BUILDKITE_PLUGIN_NAME".freeze
+  # A JSON object containing a list plugins used in the step, and their configuration.
+  BUILDKITE_PLUGINS = "BUILDKITE_PLUGINS".freeze
+  # The opposite of the value of the `no-plugins` [agent configuration option](/docs/agent/v3/configuration).
+  BUILDKITE_PLUGINS_ENABLED = "BUILDKITE_PLUGINS_ENABLED".freeze
+  # The value of the `plugins-path` [agent configuration option](/docs/agent/v3/configuration).
+  BUILDKITE_PLUGINS_PATH = "BUILDKITE_PLUGINS_PATH".freeze
+  # Whether to validate plugin configuration and requirements. The value can be modified by exporting the environment variable in the `environment` or `pre-checkout` hooks, or in a `pipeline.yml` file. It can also be enabled using the `no-plugin-validation` [agent configuration option](/docs/agent/v3/configuration).
+  BUILDKITE_PLUGIN_VALIDATION = "BUILDKITE_PLUGIN_VALIDATION".freeze
+  # The number of the pull request or `false` if not a pull request.
+  BUILDKITE_PULL_REQUEST = "BUILDKITE_PULL_REQUEST".freeze
+  # The base branch that the pull request is targeting or `""` if not a pull request.`
+  BUILDKITE_PULL_REQUEST_BASE_BRANCH = "BUILDKITE_PULL_REQUEST_BASE_BRANCH".freeze
+  # Set to `true` when the pull request is a draft. This variable is only available if a build contains a draft pull request.
+  BUILDKITE_PULL_REQUEST_DRAFT = "BUILDKITE_PULL_REQUEST_DRAFT".freeze
+  # The repository URL of the pull request or `""` if not a pull request.
+  BUILDKITE_PULL_REQUEST_REPO = "BUILDKITE_PULL_REQUEST_REPO".freeze
+  # The UUID of the original build this was rebuilt from or `""` if not a rebuild.
+  BUILDKITE_REBUILT_FROM_BUILD_ID = "BUILDKITE_REBUILT_FROM_BUILD_ID".freeze
+  # The number of the original build this was rebuilt from or `""` if not a rebuild.
+  BUILDKITE_REBUILT_FROM_BUILD_NUMBER = "BUILDKITE_REBUILT_FROM_BUILD_NUMBER".freeze
+  # A custom refspec for the buildkite-agent bootstrap script to use when checking out code. This variable can be modified by exporting the environment variable in the `environment` or `pre-checkout` hooks.
+  BUILDKITE_REFSPEC = "BUILDKITE_REFSPEC".freeze
+  # The repository of your pipeline. This variable can be set by exporting the environment variable in the `environment` or `pre-checkout` hooks.
+  BUILDKITE_REPO = "BUILDKITE_REPO".freeze
+  # The path to the shared git mirror. Introduced in [v3.47.0](https://github.com/buildkite/agent/releases/tag/v3.47.0).
+  BUILDKITE_REPO_MIRROR = "BUILDKITE_REPO_MIRROR".freeze
+  # How many times this job has been retried.
+  BUILDKITE_RETRY_COUNT = "BUILDKITE_RETRY_COUNT".freeze
+  # The access key ID for your S3 IAM user, for use with [private S3 buckets](/docs/agent/v3/cli-artifact#using-your-private-aws-s3-bucket). The variable is read by the `buildkite-agent artifact upload` command, and during the artifact upload phase of [command steps](/docs/pipelines/command-step#command-step-attributes). The value can only be set by exporting the environment variable in the `environment`, `pre-checkout` or `pre-command` hooks.
+  BUILDKITE_S3_ACCESS_KEY_ID = "BUILDKITE_S3_ACCESS_KEY_ID".freeze
+  # The access URL for your [private S3 bucket](/docs/agent/v3/cli-artifact#using-your-private-aws-s3-bucket), if you are using a proxy. The variable is read by the `buildkite-agent artifact upload` command, as well as during the artifact upload phase of [command steps](/docs/pipelines/command-step#command-step-attributes). The value can only be set by exporting the environment variable in the `environment`, `pre-checkout` or `pre-command` hooks.
+  BUILDKITE_S3_ACCESS_URL = "BUILDKITE_S3_ACCESS_URL".freeze
+  # The Access Control List to be set on artifacts being uploaded to your [private S3 bucket](/docs/agent/v3/cli-artifact#using-your-private-aws-s3-bucket). The variable is read by the `buildkite-agent artifact upload` command, as well as during the artifact upload phase of [command steps](/docs/pipelines/command-step#command-step-attributes). The value can only be set by exporting the environment variable in the `environment`, `pre-checkout` or `pre-command` hooks.
+  #
+  # Must be one of the following values which map to [S3 Canned ACL grants](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl).
+  BUILDKITE_S3_ACL = "BUILDKITE_S3_ACL".freeze
+  # The region of your [private S3 bucket](/docs/agent/v3/cli-artifact#using-your-private-aws-s3-bucket). The variable is read by the `buildkite-agent artifact upload` command, as well as during the artifact upload phase of [command steps](/docs/pipelines/command-step#command-step-attributes). The value can only be set by exporting the environment variable in the `environment`, `pre-checkout` or `pre-command` hooks.
+  BUILDKITE_S3_DEFAULT_REGION = "BUILDKITE_S3_DEFAULT_REGION".freeze
+  # The secret access key for your S3 IAM user, for use with [private S3 buckets](/docs/agent/v3/cli-artifact#using-your-private-aws-s3-bucket). The variable is read by the `buildkite-agent artifact upload` command, as well as during the artifact upload phase of [command steps](/docs/pipelines/command-step#command-step-attributes). The value can only be set by exporting the environment variable in the `environment`, `pre-checkout` or `pre-command` hooks. Do not print or export this variable anywhere except your agent hooks.
+  BUILDKITE_S3_SECRET_ACCESS_KEY = "BUILDKITE_S3_SECRET_ACCESS_KEY".freeze
+  # Whether to enable encryption for the artifacts in your [private S3 bucket](/docs/agent/v3/cli-artifact#using-your-private-aws-s3-bucket). The variable is read by the `buildkite-agent artifact upload` command, as well as during the artifact upload phase of [command steps](/docs/pipelines/command-step#command-step-attributes). The value can only be set by exporting the environment variable in the `environment`, `pre-checkout` or `pre-command` hooks.
+  BUILDKITE_S3_SSE_ENABLED = "BUILDKITE_S3_SSE_ENABLED".freeze
+  # The value of the `shell` [agent configuration option](/docs/agent/v3/configuration).
+  BUILDKITE_SHELL = "BUILDKITE_SHELL".freeze
+  # The source of the event that created the build.
+  BUILDKITE_SOURCE = "BUILDKITE_SOURCE".freeze
+  # The opposite of the value of the `no-ssh-keyscan` [agent configuration option](/docs/agent/v3/configuration).
+  BUILDKITE_SSH_KEYSCAN = "BUILDKITE_SSH_KEYSCAN".freeze
+  # A unique string that identifies a step.
+  BUILDKITE_STEP_ID = "BUILDKITE_STEP_ID".freeze
+  # The value of the `key` [command step attribute](/docs/pipelines/command-step#command-step-attributes), a unique string set by you to identify a step.
+  BUILDKITE_STEP_KEY = "BUILDKITE_STEP_KEY".freeze
+  # The name of the tag being built, if this build was triggered from a tag.
+  BUILDKITE_TAG = "BUILDKITE_TAG".freeze
+  # The number of minutes until Buildkite automatically cancels this job, if a timeout has been specified, otherwise it `false` if no timeout is set. Jobs that time out with an exit status of 0 are marked as "passed".
+  BUILDKITE_TIMEOUT = "BUILDKITE_TIMEOUT".freeze
+  # Set to `"datadog"` to send metrics to the [Datadog APM](https://docs.datadoghq.com/tracing/) using `localhost:8126`, or `DD_AGENT_HOST:DD_AGENT_APM_PORT`.
+  #
+  # Also available as a [buildkite agent configuration option.](/docs/agent/v3/configuration#configuration-settings)
+  BUILDKITE_TRACING_BACKEND = "BUILDKITE_TRACING_BACKEND".freeze
+  # The UUID of the build that triggered this build. This will be empty if the build was not triggered from another build.
+  BUILDKITE_TRIGGERED_FROM_BUILD_ID = "BUILDKITE_TRIGGERED_FROM_BUILD_ID".freeze
+  # The number of the build that triggered this build or `""` if the build was not triggered from another build.
+  BUILDKITE_TRIGGERED_FROM_BUILD_NUMBER = "BUILDKITE_TRIGGERED_FROM_BUILD_NUMBER".freeze
+  # The slug of the pipeline that was used to trigger this build or `""` if the build was not triggered from another build.
+  BUILDKITE_TRIGGERED_FROM_BUILD_PIPELINE_SLUG = "BUILDKITE_TRIGGERED_FROM_BUILD_PIPELINE_SLUG".freeze
+  # The name of the user who unblocked the build.
+  BUILDKITE_UNBLOCKER = "BUILDKITE_UNBLOCKER".freeze
+  # The notification email of the user who unblocked the build.
+  BUILDKITE_UNBLOCKER_EMAIL = "BUILDKITE_UNBLOCKER_EMAIL".freeze
+  # The UUID of the user who unblocked the build.
+  BUILDKITE_UNBLOCKER_ID = "BUILDKITE_UNBLOCKER_ID".freeze
+  # A colon separated list of non-private team slugs that the user who unblocked the build belongs to.
+  BUILDKITE_UNBLOCKER_TEAMS = "BUILDKITE_UNBLOCKER_TEAMS".freeze
+  # Always `true`.
+  CI = "CI".freeze
+end

data/project.json

@@ -0,0 +1,81 @@
+{
+    "name": "sdk-ruby",
+    "$schema": "../../node_modules/nx/schemas/project-schema.json",
+    "sourceRoot": "sdk/ruby",
+    "projectType": "library",
+    "tags": [],
+    "targets": {
+        "clean": {
+            "executor": "nx:run-commands",
+            "options": {
+                "commands": [
+                    "rimraf .yardoc",
+                    "rimraf .rspec_status",
+                    "rimraf pkg"
+                ],
+                "cwd": "sdk/ruby"
+            },
+            "cache": false
+        },
+        "install": {
+            "executor": "nx:run-commands",
+            "options": {
+                "commands": ["bundle install"],
+                "cwd": "sdk/ruby"
+            },
+            "cache": false
+        },
+        "format": {
+            "executor": "nx:run-commands",
+            "options": {
+                "commands": ["bundle exec rubocop -A"],
+                "cwd": "sdk/ruby"
+            },
+            "cache": false
+        },
+        "build": {
+            "executor": "nx:run-commands",
+            "outputs": ["{projectRoot}/dist/sdks/ruby"],
+            "options": {
+                "commands": ["bundle exec rake build"],
+                "cwd": "sdk/ruby"
+            },
+            "cache": false
+        },
+        "publish": {
+            "executor": "nx:run-commands",
+            "options": {
+                "commands": ["gem push buildkite-sdk-$VERSION.gem"],
+                "cwd": "dist/sdks/ruby",
+                "env": {
+                    "VERSION": "0.0.1"
+                }
+            },
+            "cache": false
+        },
+        "test": {
+            "executor": "nx:run-commands",
+            "options": {
+                "commands": ["bundle install", "bundle exec rspec spec"],
+                "cwd": "sdk/ruby"
+            },
+            "cache": false
+        },
+        "docs:build": {
+            "executor": "nx:run-commands",
+            "outputs": ["{workspaceRoot}/dist/docs/ruby"],
+            "options": {
+                "command": "bundle exec yard doc lib --output-dir ../../dist/docs/ruby",
+                "cwd": "sdk/ruby"
+            },
+            "cache": false
+        },
+        "docs:serve": {
+            "executor": "@nx/web:file-server",
+            "options": {
+                "port": 8082,
+                "buildTarget": "docs:build"
+            }
+        }
+    }
+}

data/sig/buildkite.rbs

@@ -0,0 +1,26 @@
+# See the writing guide of rbs: https://github.com/ruby/rbs#guides
+module Buildkite
+  VERSION: String
+
+  class CommandStep
+    attr_reader label: String
+    attr_reader commands: Array[String]
+  end
+
+  class BlockStep
+    attr_reader label: String
+    attr_reader block: String
+  end
+
+  class Pipeline
+    @steps: Array[CommandStep | BlockStep]
+
+    def initialize: () -> void
+
+    def add_step: (step: CommandStep | BlockStep) -> self
+
+    def to_json: () -> untyped
+
+    def to_yaml: () -> untyped
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: buildkite-sdk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Christian Nunciato
+bindir: exe
+cert_chain: []
+date: 2025-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: A Ruby SDK for Buildkite!
+email:
+- chris.nunciato@buildkite.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- README.md
+- Rakefile
+- env.mustache
+- lib/buildkite.rb
+- lib/buildkite/version.rb
+- lib/environment.rb
+- project.json
+- sig/buildkite.rbs
+homepage: https://buildkite.com
+licenses: []
+metadata:
+  homepage_uri: https://buildkite.com
+  source_code_uri: https://github.com/buildkite/buildkite-sdk
+  changelog_uri: https://github.com/buildkite/buildkite-sdk
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A Ruby SDK for Buildkite!
+test_files: []