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: release history webpage contains suboptimal links #35988

Closed
AlekSi opened this issue Dec 5, 2019 · 8 comments
Closed

doc: release history webpage contains suboptimal links #35988

AlekSi opened this issue Dec 5, 2019 · 8 comments
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Milestone

Comments

@AlekSi
Copy link
Contributor

AlekSi commented Dec 5, 2019

What did you do?

Opened https://golang.org/doc/devel/release.html#go1.13.minor containing this text:

go1.13.5 (released 2019/12/04) includes fixes to the go command, the runtime, the linker, and the net/http package. See the Go 1.13.5 milestone on our issue tracker for details.

Followed a link to the GitHub milestone: https://github.com/golang/go/issues?q=milestone%3AGo1.13.5

What did you expect to see?

Issues fixed in 1.13.5.

What did you see instead?

Issues considered for 1.13.5, including the ones that were not backported. For example: #34642

I think either @gopherbot should remove milestone from issues without CherryPickApproved label after release is done, or link in documentation should include this label.

See also #35119 (comment) and below.

@AlekSi
Copy link
Contributor Author

AlekSi commented Dec 5, 2019

/cc @dmitshur

@dmitshur
Copy link
Contributor

dmitshur commented Dec 5, 2019

I agree the current link leads to a page that is hard to read. We shouldn't remove issues from that milestone, because then it will be harder to track history and know what was considered but not accepted. I think a better fix is to add the CherryPickApproved label filter to the link.

We've done this for some past releases (e.g., Go 1.12.9, 1.11.14, and 1.10.7) but not all. We need to adjust the release process so this happens for future releases.

In the mean time, please use this link:

https://github.com/golang/go/issues?q=milestone%3AGo1.13.5+label%3ACherryPickApproved

/cc @toothrot @cagedmantis @andybons

@dmitshur dmitshur added the NeedsFix The path to resolution is known, but the work has not been done. label Dec 5, 2019
@dmitshur dmitshur added this to the Unreleased milestone Dec 5, 2019
@gopherbot
Copy link

Change https://golang.org/cl/209918 mentions this issue: doc: add CherryPickApproved filter to Release History links

@dmitshur
Copy link
Contributor

dmitshur commented Dec 5, 2019

I went through the release history a bit. We started consistently using the CherryPickCandidate and CherryPickApproved labels with Go 1.9.1 and later. They weren't used before Go 1.9. I fixed up some minor inconsistencies (i.e., where a change was acutally cherry-picked but its backport issue was missing CherryPickApproved label) in 1.9-1.10; going through 1.11-1.13 releases is still a TODO.

Sent CL 209918 to add the CherryPickApproved label filter to links for all releases after Go 1.9 for review.

@dmitshur dmitshur changed the title doc: release history webpage contains invalid links doc: release history webpage contains suboptimal links Dec 5, 2019
@dmitshur
Copy link
Contributor

dmitshur commented Dec 5, 2019

@gopherbot, could you please be so kind as to open two backport issues: one for Go 1.13 and another for Go 1.12. This is a documentation fix.

@gopherbot
Copy link

Backport issue(s) opened: #36002 (for 1.12), #36003 (for 1.13).

Remember to create the cherry-pick CL(s) as soon as the patch is submitted to master, according to https://golang.org/wiki/MinorReleases.

@gopherbot
Copy link

Change https://golang.org/cl/210117 mentions this issue: [release-branch.go1.13] doc: add CherryPickApproved filter to Release History links

@gopherbot
Copy link

Change https://golang.org/cl/210118 mentions this issue: [release-branch.go1.12] doc: add CherryPickApproved filter to Release History links

@dmitshur dmitshur self-assigned this Dec 5, 2019
gopherbot pushed a commit that referenced this issue Dec 9, 2019
… History links

Not all closed issues in a given minor milestone are included in that
release, only the ones that have been labeled as CherryPickApproved are.

Update the links to the GitHub issue tracker to include a filter on the
CherryPickApproved label, so that the default view shows only the
backports that were included in a given release. This should more useful
to most people than seeing all backports (considered and approved).

Do this only for Go 1.9.1 and newer releases, as that is when we started
using the CherryPickCandidate and CherryPickApproved labels.

Updates #35988
Fixes #36002

Change-Id: I51e07c1bc3ab9c4a5744e8f668c5470adf78bffe
Reviewed-on: https://go-review.googlesource.com/c/go/+/210118
Run-TryBot: Dmitri Shuralyov <dmitshur@golang.org>
Reviewed-by: Alexander Rakoczy <alex@golang.org>
TryBot-Result: Gobot Gobot <gobot@golang.org>
gopherbot pushed a commit that referenced this issue Dec 9, 2019
… History links

Not all closed issues in a given minor milestone are included in that
release, only the ones that have been labeled as CherryPickApproved are.

Update the links to the GitHub issue tracker to include a filter on the
CherryPickApproved label, so that the default view shows only the
backports that were included in a given release. This should more useful
to most people than seeing all backports (considered and approved).

Do this only for Go 1.9.1 and newer releases, as that is when we started
using the CherryPickCandidate and CherryPickApproved labels.

Updates #35988
Fixes #36003

Change-Id: I51e07c1bc3ab9c4a5744e8f668c5470adf78bffe
Reviewed-on: https://go-review.googlesource.com/c/go/+/210117
Run-TryBot: Dmitri Shuralyov <dmitshur@golang.org>
Reviewed-by: Alexander Rakoczy <alex@golang.org>
TryBot-Result: Gobot Gobot <gobot@golang.org>
@golang golang locked and limited conversation to collaborators Dec 4, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Development

No branches or pull requests

3 participants