https://github.com/shopify/buildkit
API wrapper for buildkite https://buildkite.com/docs/api/
https://github.com/shopify/buildkit
buildkite
Last synced: 6 months ago
JSON representation
API wrapper for buildkite https://buildkite.com/docs/api/
- Host: GitHub
- URL: https://github.com/shopify/buildkit
- Owner: Shopify
- License: mit
- Created: 2015-04-22T20:55:22.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2024-09-20T12:53:20.000Z (about 1 year ago)
- Last Synced: 2025-04-09T05:12:28.660Z (6 months ago)
- Topics: buildkite
- Language: Ruby
- Size: 173 KB
- Stars: 57
- Watchers: 484
- Forks: 25
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Buildkit
Ruby toolkit for the Buildkite API.
[](http://badge.fury.io/rb/buildkit)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'buildkit'
```
And then execute:
$ bundle
## Usage
`Buildkit` follow the same patterns than [`Octokit`](https://github.com/octokit/octokit.rb), if you are familiar with it you should feel right at home.
```ruby
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](https://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