Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kevinburke/buildkite
Buildkite CLI tool
https://github.com/kevinburke/buildkite
Last synced: 29 days ago
JSON representation
Buildkite CLI tool
- Host: GitHub
- URL: https://github.com/kevinburke/buildkite
- Owner: kevinburke
- License: other
- Created: 2022-03-08T19:25:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-26T03:56:06.000Z (4 months ago)
- Last Synced: 2024-07-27T01:43:24.500Z (4 months ago)
- Language: Go
- Size: 4.08 MB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS.txt
Awesome Lists containing this project
README
# buildkite-go
This is a Buildkite client that's designed to be used with Buildkite builds. It
will wait for the current Git commit to build and then tell you whether it
passed or failed.
If the build failed, we'll download the output from the failed job step and
display what happened in the terminal.
### Installation
On Mac, install with Homebrew:
```
brew install kevinburke/safe/buildkite
```
Or install from source:
```
go install github.com/kevinburke/buildkite@latest
```
If you want to get notifications when builds complete, [install the
terminal-notifier app][terminal-notifier]:
```
brew install terminal-notifier
```
[terminal-notifier]: https://github.com/julienXX/terminal-notifier
## Roadmap
Implement the features from e.g. github.com/kevinburke/go-circle, for example:
- download build artifacts
- cancel or rebuild builds on a given branch
Also add emoji support, so we can render emoji in iTerm in full fidelity.
### Configuration
You need to add a local config file. Get a API token from
https://buildkite.com/user/api-access-tokens. Once you have that, add the config
file in one of the following locations:
```
- $XDG_CONFIG_HOME/buildkite
- $HOME/cfg/buildkite
- $HOME/.buildkite
```
With these contents:
```toml
# buildkite config file: github.com/kevinburke/buildkite
# Default organization to load a token from if none of your configurations match.
default = "kevinburke"
[organizations]
# "example" is the name of your Buildkite org, buildkite.com/example
[organizations.example]
token = "buildkite_token_for_example_org"
# If your Github org name does not match the Buildkite org name, add a
# mapping here - in this case, let's say the Github org that maps to
# buildkite.com/example is at github.com/example_gh
git_remotes = [
'example_gh' # This will map github.com/example_gh => buildkite.com/example
]
# If you have more than one organization, you can add other orgs/tokens
[organizations.kevinburke]
token = "buildkite_token_for_kevinburke"
```
### Usage
`cd` to the Git repo for your Buildkite project and then write:
```
buildkite wait
```
This will wait for your build to complete and then print out summary statistics.