Use go-octokit in gh
owenthereal opened this issue · 10 comments
I can't wait to try out go-octokit in gh to make sure I'm building the right thing. Creating an issue here to track to the progress.
Cross reference: owenthereal/gh#92
@technoweenie @pengwynn I quickly integrated go-octokit with gh. Does the go-octokit abstraction feel right? https://github.com/jingweno/gh/pull/92/files. The file github/github.go is what matters
@pengwynn @technoweenie Would it be possible to publicize go-octokit? I've finished the integration between go-octokit and gh and have built all the endpoints I need to support the integration. I'd like to make a build for gh but what's blocking me right now is this repo is private. Besides people continue to contribute to the old octokat project. I want to redirect their efforts here.
If you guys find this project more like an experimental one, we could put "Experimental" on the README. What do you think?
I'm fine with it. My only worry is the Go API compatibility. How comfortable are you that the API won't change drastically?
I make no promises on API changes. That's why I keep pushing this to gh, use it and try to find out the right abstractions. The Go API compatibility stuff IMHO is good in theory but very hard to achieve in practice (that's also one of the reasons that they didn't implement versioning in Go's dependency manager...)
Plan B is to push down all changes to octokat. But that will add cost to me to maintain two codebases.
I'm fine with opening it up with the experimental label and probably a bit of Philosophy in the README along the lines of "What does a hypermedia-driven API wrapper look like in Go?"
The goal is to have a wrapper GitHub uses, trusts, and actively hacks on. If this project can drive gh and some of our internal projects, mission accomplished.
I'd love to get feedback from @jspahrsummers before we do that though.
At this point, I'm only actively using go-sawyer to talk to internal APIs.
The philosophy bit is a big 👍 from me. Let's start that in the form of a PR and iterate from there.
Also, going through and documenting grohl was a great exercise for me. I'd like to see sawyer and octokit get similar attention.
I'm fine with opening it up with the experimental label and probably a bit of Philosophy in the README along the lines of "What does a hypermedia-driven API wrapper look like in Go?"
👍 I think it's perfectly appropriate to treat this as an experimental project but still release it to the world. I wouldn't add it to http://octokit.github.io just yet, though.
@jspahrsummers Sweet.
@jingweno: Let's just make sure the readme clearly states this is experimental, and we're good to go. I'd say any other docs or the bit on the philosophy can wait for a real Go release or blog post.
@technoweenie Sounds good, done: #31
hooray 😸