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

x/tools/gopls: design/document new release policy #55267

Open
findleyr opened this issue Sep 20, 2022 · 0 comments
Open

x/tools/gopls: design/document new release policy #55267

findleyr opened this issue Sep 20, 2022 · 0 comments
Assignees
Labels
Documentation gopls Issues related to the Go language server, gopls. Tools This label describes issues relating to any tools in the x/tools repository.
Milestone

Comments

@findleyr
Copy link
Contributor

findleyr commented Sep 20, 2022

Background

Historically, we've endeavored to do a new gopls release ~monthly, in order to stay up-to-date with dependencies and minimize delta. Typically we'd cut a new minor version (e.g. gopls@v0.9.0) whenever there is a significant improvement that we'd like to highlight. At this point we'd create a new release branch (e.g. gopls-release-branch.0.9), and subsequently merge from master to the release branch whenever we cut patch releases (e.g. gopls@v0.9.1).

Problems

There are some problems with this model that we'd like to solve:

  1. Releasing is tedious. Releasing involves multiple CLs, smoke testing, writing release notes, etc. We are working on integrating with the release team's new Relui automation, which should make the process of releasing easier, but it doesn't eliminate the need for manual verification of releases, writing release notes, or promoting the prerelease.
  2. Releasing is risky. For example, see x/tools/gopls: follow-up to golang/vscode-go#2406 (analyzer print statement breaking gopls) #54459. While we continue to invest in testing and benchmarking, it is unfortunately true that
    a. gopls has significant technical debt that we're still paying down
    b. gopls interacts heavily with the operating system, and so is subject to differing behavior across platforms (example)
    c. gopls interacts with dozens of different editors and LSP clients, many of which have subtly different behavior (example)
    d. gopls has no telemetry, and user reports are sparse and sporadic
  3. Historically, releases haven't followed the spirit of semver. While we try to associate minor versions with "significant" changes, we have introduced new features in patch versions. Because we have been merging from master, there is also no reason to expect that patch releases are incrementally more stable: we introduced breakages such as x/tools/gopls: follow-up to golang/vscode-go#2406 (analyzer print statement breaking gopls) #54459 in patch releases.

Proposed Change

I propose to address these problems by adopting a release policy more similar to that of the main Go distribution (albeit every 3 months rather than 6):

  • Only merge from master for *.*.0 patch releases. Instead of merging for each patch release, only merge when we initially cut our minor version release branches, corresponding to the *.*.0 patch release. Subsequent patch releases will contain only cherry-picked CLs, ideally only bug fixes.
  • Target minor releases every ~3 months. Try to stick to a schedule of releasing new minor versions every 3 months. This will allow a regular pace of new features, and allow us to coordinate with the Go release, but will reduce churn.
  • Let new minor versions soak in prerelease for longer. In the past, we've let prereleases soak for a few days, longer if we think they are risky. With this new policy, I think new minor versions should soak in prerelease for at least two weeks.
  • Heavily promote minor version prereleases. Recently we've tried promoting risky prereleases on gophers Slack, with moderate success. We can do more: a devlog, twitter post, or nightly channel for the main vscode-go extension. We can also encourage non-vscode LSP clients to have a nightly channel.
  • Fully automate patch releases. If subsequent patch releases consist only of a small number of bug fixes, it should be possible to fully automate them in Relui, including their release notes and publication.
  • Target patch releases every ~month. Since patch releases should be easy, releasing every month should no longer introduce significant toil.
  • Document this policy, for reference and to set expectations.

CC @golang/tools-team

@gopherbot gopherbot added Tools This label describes issues relating to any tools in the x/tools repository. gopls Issues related to the Go language server, gopls. labels Sep 20, 2022
@gopherbot gopherbot added this to the Unreleased milestone Sep 20, 2022
@findleyr findleyr self-assigned this Sep 22, 2022
@findleyr findleyr modified the milestones: Unreleased, gopls/v0.10.0 Sep 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation gopls Issues related to the Go language server, gopls. Tools This label describes issues relating to any tools in the x/tools repository.
Projects
None yet
Development

No branches or pull requests

2 participants