shopify / buildkit

API wrapper for buildkite https://buildkite.com/docs/api/

Buildkit

Ruby toolkit for the Buildkite API.

Installation

Add this line to your application's Gemfile:

gem 'buildkit'

And then execute:

$ bundle

Usage

Buildkit follow the same patterns than Octokit, if you are familiar with it you should feel right at home.

client = Buildkit.new(token: 't0k3n')
organization = client.organization('my-great-org')
agents = organization.rels[:agents].get.data

Development

After checking out the repo, run bin/setup to install dependencies. Then, 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 to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

1. Fork it ( https://github.com/shopify/buildkit/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

buildkit's Issues

Bump to version 0.3

Oh hai! Any chance you could bump and release a new version so we can use the sweet new #create_build API? 😍

Pagination support

correct me if i'm wrong but it seems that the sdk does not support pagination. any chance you could implement that?

Add ruby 3.2 and 3.3 to buildkit CI test matrix

When using buildkit for a ruby 3.3 project we noticed the gem is not testing against ruby 3.2 and 3.3. Here's a small pr adding those passing builds to the test matrix #42.

permission issue when doing a docker pull from gcr

background

Starscream is moving over from locutus to pipa, and in the process, we're seeing around 3min of extra time being added when pushing to legacy registry (PIPA_LEGACY_REPO=registry.shopify.io/starscream-ci). The overarching goal is to minimize as much of that 3min as possible to the ci time.

potential solution 1

have the agents pull down their docker containers from gcr. When we do this, however, we hit the following permission issue

/usr/bin/timeout 5m docker pull gcr.io/shopify-docker-images/apps/ci/starscream:511da35bbc76d04181e37021bfc0dae639c8ef16
Error response from daemon: denied: Permission denied for "511da35bbc76d04181e37021bfc0dae639c8ef16" from request "/v2/shopify-docker-images/apps/ci/starscream/manifests/511da35bbc76d04181e37021bfc0dae639c8ef16".

potential solution 2

Have buildkite run out of GC instead of AWS. I have no idea how to do this.

@DazWorrall

Ability to archive/unarchive a pipeline

We want to be able to archive/unarchive a pipeline https://buildkite.com/docs/apis/rest-api/pipelines#archive-a-pipeline
Buildkite supports these actions in both the REST and Graphql APIs.

@casperisfine is there any reason for us not to implement this?

Confusing naming

The gem name "buildkit" doesn't make it immediately obvious is a Buildkite API client. It could be confused with e.g. Docker BuildKit https://docs.docker.com/develop/develop-images/build_enhancements/

I suggest the project should be renamed to something like buildkite-api or buildkite-client

Bump new version

Hey guys!

I noticed that you haven't made a new release that includes #12 . This is something I'd love for some analytics work I'm developing. Would you guys be able to push a new version?

Thanks!