search

buildkite / golang-example

An example on how to test a Golang program using Buildkite
https://github.com/buildkite/example-pipelines
MIT License
13 stars 15 forks source link

purpose of project.json? #5

Closed nhooyr closed 5 years ago

nhooyr commented 5 years ago

https://github.com/buildkite/golang-example/blob/b33574c9c44322ca3ce74622e804460c68b754a5/.buildkite/project.json

toolmantim commented 5 years ago

This helps power the "Add to Buildkite" button in the readme. Not something you'd typically need for your own projects, but if they're open source, and you want people to easily set up the repo in their own Buildkite account, then you can add one to your own repos too.

nhooyr commented 5 years ago

This behaviour could use better documentation.

toolmantim commented 5 years ago

You're absolutely right. Sorry that it was confusing.

I just updated all the example repos to use a template.yml file instead, which allows for a comment to explain what it is, and I also added a note to the examples-pipelines index (https://github.com/buildkite/example-pipelines/commit/0d1d226fab50ece6963f5e02eeec7a2979656bc9) saying you don't need this file in your own projects.

Hope that helps, and sorry again for the confusion!