Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

x/build/gerrit: document lack of stable API #18743

Closed
bradfitz opened this issue Jan 22, 2017 · 2 comments
Closed

x/build/gerrit: document lack of stable API #18743

bradfitz opened this issue Jan 22, 2017 · 2 comments
Labels
Documentation FrozenDueToAge
Milestone
Unreleased

Comments

@bradfitz
Copy link
Contributor

The golang.org/x/build/gerrit package is a private implementation detail of the Go build system.

I have no time nor desire to maintain a complete and stable API for Gerrit.

We need to document that people are able to use it if they like, but it may change without notice, and it's on them to vendor it.

We have such notices on other packages, but I forgot to add it to the Gerrit package. And maybe it's missing in other x/build/*** packages.
@bradfitz bradfitz added this to the Unreleased milestone Jan 22, 2017
@bradfitz bradfitz mentioned this issue Jan 22, 2017
Closed
@kevinburke
Copy link
Contributor

Problem with gopherbot? Here's my commit message which is (I believe) formatted correctly but no comment.

gerrit: support contexts

Switch all API methods that make requests to Gerrit to take a
context.Context as their first argument. Adds a package example and
a simple test that we make requests to the correct endpoint and that
the Client can handle correct responses and error responses from the
Gerrit server.

Switches all code in the x/build tree to use the new Gerrit
client. There are several projects outside the tree that import
x/build/gerrit; I'll submit CL's against those to pull in the new
interface once this gets merged.

Documents that the API is unstable.

Fixes golang/go#18742.
Fixes golang/go#18743.

Change-Id: Ifa78cbb058981e23cf5769955f6312fcbe08e174

https://go-review.googlesource.com/#/c/35559/

@gopherbot
Copy link

CL https://golang.org/cl/35559 mentions this issue.

@golang golang locked and limited conversation to collaborators Jan 23, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation FrozenDueToAge
Projects
None yet
Milestone
Unreleased
Development

No branches or pull requests
3 participants
@bradfitz @kevinburke @gopherbot