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/tools/gopls: auto-generate API diff for releases #46652

Closed
findleyr opened this issue Jun 8, 2021 · 4 comments
Closed

x/tools/gopls: auto-generate API diff for releases #46652

findleyr opened this issue Jun 8, 2021 · 4 comments
Labels
FrozenDueToAge gopls Issues related to the Go language server, gopls. NeedsFix The path to resolution is known, but the work has not been done. Tools This label describes issues relating to any tools in the x/tools repository.
Milestone
gopls/v0.7.3

Comments

@findleyr
Copy link
Contributor

findleyr commented Jun 8, 2021

From our team meeting: gopls auto-generates documentation for both its workspace/executeCommand API and its settings.

We should use this metadata to generate an API diff to attach to our releases, similar to how cmd/api works in the Go repo.

This may have helped in golang/vscode-go#1549

CC @hyangah @stamblerre
@findleyr findleyr added the NeedsFix The path to resolution is known, but the work has not been done. label Jun 8, 2021
@findleyr findleyr added this to the gopls/v1.0.0 milestone Jun 8, 2021
@findleyr findleyr added the gopls Issues related to the Go language server, gopls. label Jun 8, 2021
@gopherbot gopherbot added the Tools This label describes issues relating to any tools in the x/tools repository. label Jun 8, 2021
@findleyr
Copy link
Contributor Author

findleyr commented Jun 8, 2021

This is probably as simple as capturing internal/lsp/source/api_json.go for each release. We can check it in, similar Go's api/ directory.

This could also be used to generate 'added in gopls v0.7.0' commentary in our documentation.

@findleyr findleyr modified the milestones: gopls/v1.0.0, gopls/v0.7.1 Jun 11, 2021
@danishprakash
Copy link

I'd like to try this out @findleyr, let me know if that's okay.

@findleyr
Copy link
Contributor Author

@danishprakash I believe @stamblerre already has an in-progress CL doing this.

@stamblerre stamblerre modified the milestones: gopls/v0.7.1, gopls/v0.7.2 Jul 26, 2021
@gopherbot
Copy link

Change https://golang.org/cl/327276 mentions this issue: gopls/api-diff: create api-diff command for gopls api

@stamblerre stamblerre modified the milestones: gopls/v0.7.2, gopls/on-deck Sep 9, 2021
@golang golang locked and limited conversation to collaborators Jun 23, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge gopls Issues related to the Go language server, gopls. NeedsFix The path to resolution is known, but the work has not been done. Tools This label describes issues relating to any tools in the x/tools repository.
Projects
None yet
Milestone
gopls/v0.7.3
Development

No branches or pull requests
4 participants
@stamblerre @gopherbot @danishprakash @findleyr