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

doc, x/website: move "Release History" content to x/website #36075

Closed
dmitshur opened this issue Dec 10, 2019 · 3 comments
Closed

doc, x/website: move "Release History" content to x/website #36075

dmitshur opened this issue Dec 10, 2019 · 3 comments
Assignees
Milestone

Comments

@dmitshur
Copy link
Member

@dmitshur dmitshur commented Dec 10, 2019

I plan to move the Release History page (along with two other pages in https://golang.org/doc/devel/ with pre-Go 1 history) from the main Go repository to the x/website repository. This is a subset of #29206, and this change will help improve the Go release process. The background section elaborates on the benefits.

This is the tracking issue. Relevant steps:

  • reduce scope of cmd/godoc so it no longer displays website (#32011)
  • add a copy of doc/devel/release.html (and two other files in doc/devel) to x/website (CL 210797)
  • remove old instance of doc/devel/release.html (and the two other files) from Go repo (CL 210798)
  • update releasebot to not check doc/devel/release.html for new entry in Go repo as a blocking step (CL 210957)

Background

When making minor Go releases, the first time-intensive automated step in the release process is the releasebot -mode=prepare command. Before it can be started, the Release History page needs to be updated to include the two new minor versions. This involves creating, reviewing, and submitting 5 CLs in the main repository:

  1. CL A to add go1.N.x entry to doc/devel/release.html. Example: CL 154302.
  2. CL B to add go1.{N-1}.x entry to doc/devel/release.html. Example: CL 154303.
  3. Cherry-pick CL A to release-branch.go1.N. Example: CL 154306.
  4. Cherry-pick CL B to release-branch.go1.N. Example: CL 154304.
  5. Cherry-pick CL B to release-branch.go1.{N-1}. Example: CL 154305.

This is more expensive, time intensive, and error prone than it could be made today. There are two reasons why it was originally done this way:

  1. The golang.org website used to be available for running locally via the godoc command.
  2. The godoc command used to be provided as part of the Go release.

Point 1 is no longer true. We have changed the canonical website from x/tools/cmd/godoc to x/website/cmd/golangorg (see issues 29206 and 32011). godoc’s website content is becoming stale.

Point 2 is no longer true for Go 1.13 and newer. Go 1.12 was the last release that bundled the godoc command as part of the binary distribution.

After this change, the process of creating, reviewing, and submitting 5 CLs to the main repository before the release can be cut will be replaced with a single step that can be done asynchronously (e.g., while a long-running automated command is running):

  1. Create a CL to x/website to add go1.N.x and go1.N-1.x entries to x/website/content/static/doc/devel/release.html.

During the time that Go 1.12 is still supported (until Go 1.14 is released), we will also need to update its release branch because it has an old godoc bundled that displays the website.

/cc @toothrot @cagedmantis @andybons @jayconrod @rsc

@dmitshur dmitshur added this to the Go1.14 milestone Dec 10, 2019
@dmitshur dmitshur self-assigned this Dec 10, 2019
@gopherbot
Copy link

@gopherbot gopherbot commented Dec 10, 2019

Change https://golang.org/cl/210797 mentions this issue: content/static/doc: copy Release History pages from Go repo

@gopherbot
Copy link

@gopherbot gopherbot commented Dec 10, 2019

Change https://golang.org/cl/210798 mentions this issue: doc: remove Release History pages (moved to x/website)

gopherbot pushed a commit to golang/website that referenced this issue Dec 11, 2019
The Release History, Pre-Go 1 Release History, and Weekly Snapshot
History pages are copied from Go master as of 2019/12/10 (commit
golang/go@931fe39, CL 210717).

Updates golang/go#36075
Updates golang/go#29206

Change-Id: I24d24d6346405df2d3d657ea2b4aa049182d5141
Reviewed-on: https://go-review.googlesource.com/c/website/+/210797
Run-TryBot: Dmitri Shuralyov <dmitshur@golang.org>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Alexander Rakoczy <alex@golang.org>
gopherbot pushed a commit that referenced this issue Dec 11, 2019
These pages were moved to the x/website repo in CL 210797 (commit
golang/website@9aef1ee).
Remove the old copies in this repo since they're no longer used.

Updates #36075
Updates #29206

Change-Id: I6e3ffaebd92fa753cb5f3b21e4238edfb7f5f0e8
Reviewed-on: https://go-review.googlesource.com/c/go/+/210798
Reviewed-by: Alexander Rakoczy <alex@golang.org>
@gopherbot
Copy link

@gopherbot gopherbot commented Dec 11, 2019

Change https://golang.org/cl/210957 mentions this issue: cmd/releasebot: check for Release History entry only for Go 1.12

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.