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: write release notes for Go 1.23 #65614

Open
dmitshur opened this issue Feb 8, 2024 · 35 comments
Open

doc: write release notes for Go 1.23 #65614

dmitshur opened this issue Feb 8, 2024 · 35 comments
Labels
Documentation NeedsFix The path to resolution is known, but the work has not been done. release-blocker
Milestone

Comments

@dmitshur
Copy link
Contributor

dmitshur commented Feb 8, 2024

This is the tracking issue for writing the Go 1.23 Release Notes. The version at tip can be viewed at https://tip.golang.org/doc/go1.23.

This is the first release to use the improved release note process being implemented in #64169. Also see a corresponding golang-dev thread. (CC @jba.)

Up until the the end of the development cycle (end of May), release note fragments are added inside the doc/next directory in the main Go repo. This is documented in the "For developers" section of doc/README.md:

https://go.googlesource.com/go/+/HEAD/doc/#for-developers

At the end of the development cycle, the doc/next files will be merged into a single go1.23.md file, and all remaining edits will take place in it. This merge will be handled as part of the Go release process.

The previous issue was #61422.

@dmitshur dmitshur added Documentation NeedsFix The path to resolution is known, but the work has not been done. labels Feb 8, 2024
@dmitshur dmitshur added this to the Go1.23 milestone Feb 8, 2024
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/563856 mentions this issue: doc/go1.23: document macOS requirements

gopherbot pushed a commit that referenced this issue Feb 14, 2024
For #64207.
For #65614.

Change-Id: Ia5365b4090060e0657c255341751d3e67691f836
Reviewed-on: https://go-review.googlesource.com/c/go/+/563856
Reviewed-by: Dmitri Shuralyov <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>
Auto-Submit: Dmitri Shuralyov <[email protected]>
Reviewed-by: Than McIntosh <[email protected]>
ezz-no pushed a commit to ezz-no/go-ezzno that referenced this issue Feb 18, 2024
For golang#64207.
For golang#65614.

Change-Id: Ia5365b4090060e0657c255341751d3e67691f836
Reviewed-on: https://go-review.googlesource.com/c/go/+/563856
Reviewed-by: Dmitri Shuralyov <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>
Auto-Submit: Dmitri Shuralyov <[email protected]>
Reviewed-by: Than McIntosh <[email protected]>
aimuz added a commit to aimuz/go that referenced this issue Mar 4, 2024
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/568755 mentions this issue: doc/go1.23: document database/sql wrap errors

gopherbot pushed a commit that referenced this issue Mar 4, 2024
For #64707.
For #65614.

Change-Id: Ib07ac67d7652bc7c9e1363f70637938c7bb4bc72
GitHub-Last-Rev: a4d8eca
GitHub-Pull-Request: #66089
Reviewed-on: https://go-review.googlesource.com/c/go/+/568755
Reviewed-by: Ian Lance Taylor <[email protected]>
Auto-Submit: Ian Lance Taylor <[email protected]>
Reviewed-by: Michael Knyszek <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>
@jfrech
Copy link

jfrech commented Apr 5, 2024

I think 3c78ace's changes are worth mentioning.

@ianlancetaylor
Copy link
Contributor

@jfrech Thanks, but the release notes are for changes that users need to know because they are new or because they will affect the way that programs work. We don't usually mention specific optimizations in the release notes, unless they affect the great majority of Go programs.

@gopherbot
Copy link
Contributor

Change https://go.dev/cl/587415 mentions this issue: doc/initial, doc/next: add draft notice to introduction

@gopherbot
Copy link
Contributor

Change https://go.dev/cl/587436 mentions this issue: cmd/golangorg: add doc/next page to preview draft release notes

gopherbot pushed a commit that referenced this issue May 22, 2024
Go release notes always start out as a draft with a clear notice.
That notice is removed when the final release (go1.N.0) is made.
For example, the last time was in CL 562255.

Add this to the Go 1.23 draft and to the future fragment template.

Also switch to the main pkg.go.dev instance and use a relative issue
link in 3-tools.md while here.

For #64169.
For #65614.

Change-Id: I16bc0fa8a3a43ee7a9edd7fa253999041f1892e2
Reviewed-on: https://go-review.googlesource.com/c/go/+/587415
Reviewed-by: Jonathan Amsterdam <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
TryBot-Bypass: Dmitri Shuralyov <[email protected]>
Auto-Submit: Dmitri Shuralyov <[email protected]>
gopherbot pushed a commit to golang/website that referenced this issue May 22, 2024
The improved release note process is being used starting with Go 1.23.
That means instead of a single doc/go1.23.html draft file in the main
Go repository, doc/next contains a set of release note fragments.
Having small, orthogonal files avoids merge conflicts, and a release
note test requires that release notes are written and included in the
same CL that's adding new APIs. As a result, the set of completed
release notes even before we enter the release freeze is greater than
ever before.

While it's possible to view those fragments using tip.golang.org
(e.g., by visiting https://tip.golang.org/doc/next), reading them
that way isn't practical. The relnote generate tool exists to merge
fragments into a complete Markdown document, and this tool will be
used when eventually moving a complete draft of Go 1.23 release notes
to x/website.

To aid the remaining work of completing the release note draft, this
change adds a dynamic /doc/next page to preview what the relnote
generate tool will produce. Combined with existing functionality of
the -tip flag, it makes https://tip.golang.org/doc/next display a live
preview of the checked-in release notes draft.

It can also be used to preview release note draft locally. For example,
if $HOME/gotip is a Go checkout where one is editing doc/next content:

go run golang.org/x/website/cmd/golangorg@latest -goroot=$HOME/gotip

Will serve a live preview at http:https://localhost:6060/go.dev/doc/next.
It can be slightly more convenient to refresh a browser without having
to re-run 'relnote generate'.

For golang/go#64169.
For golang/go#65614.

Change-Id: Ie1d3650076421a95a691dd84a554a113dd1187b1
Reviewed-on: https://go-review.googlesource.com/c/website/+/587436
Reviewed-by: Dmitri Shuralyov <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>
Auto-Submit: Dmitri Shuralyov <[email protected]>
Reviewed-by: Jonathan Amsterdam <[email protected]>
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/587695 mentions this issue: doc/next: document go mod tidy -diff flag

gopherbot pushed a commit that referenced this issue May 23, 2024
Add a release note for the flag that CL 585401 added.

For #27005.
For #65614.

Change-Id: Ib26eb1b85c511d3cb41a29a8d9354577dd9a0e14
Reviewed-on: https://go-review.googlesource.com/c/go/+/587695
Auto-Submit: Dmitri Shuralyov <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
Reviewed-by: Sam Thanawalla <[email protected]>
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/588015 mentions this issue: doc/next: populate TODOs found with relnote todo

gopherbot pushed a commit that referenced this issue May 23, 2024
This is the first round of TODOs created based on relnote todo output.
There are many entries that need to be documented, expanded, reworded,
and this change makes progress on setting that up.

For this cycle, relnote todo implemented a simple heuristic of finding
CLs that mention accepted proposals (see issue 62376, or comment
https://go.dev/issue/62376#issuecomment-2101086794 specifically).
The "Items that don't need to be mentioned in Go 1.23 release notes but
are picked up by relnote todo." section in todo.md contains an attempt
at reviewing that list. The large number of items needed to be reviewed
made it impractical to spend much time on any individual one.

For #65614.

Change-Id: Id9d5f1795575a46df2ec4ed0088de07ee6075a90
Reviewed-on: https://go-review.googlesource.com/c/go/+/588015
Reviewed-by: Dmitri Shuralyov <[email protected]>
Auto-Submit: Dmitri Shuralyov <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>
Reviewed-by: Carlos Amedee <[email protected]>
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/588057 mentions this issue: _content/doc: add go1.23.md placeholder

gopherbot pushed a commit to golang/website that referenced this issue May 24, 2024
Add this file now so we can use the https://tip.golang.org/doc/go1.23
both before and after the release note fragments are merged, meaning
we won't need to tell people to abruptly stop looking at /doc/next and
start looking at /doc/go1.23 sometime in the next few weeks.

The /doc/next page may still be useful in some contexts where a moving
target URL works better than a fixed one, so leave it behind for now.

For golang/go#65614.

Change-Id: Ib28608f56b2a88b44e554bf24c04873f3ed6961b
Reviewed-on: https://go-review.googlesource.com/c/website/+/588057
Reviewed-by: Dmitri Shuralyov <[email protected]>
Reviewed-by: Jonathan Amsterdam <[email protected]>
Auto-Submit: Dmitri Shuralyov <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/587927 mentions this issue: doc: add release notes for a couple minor tracing features

gopherbot pushed a commit that referenced this issue May 24, 2024
For #65614.

Change-Id: I759bf671b8f84c5224798b0dfaee6b158fdcc95a
Reviewed-on: https://go-review.googlesource.com/c/go/+/587927
Reviewed-by: Carlos Amedee <[email protected]>
Auto-Submit: Michael Knyszek <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/589015 mentions this issue: doc/next: preannounce a new Linux kernel version requirement

@gopherbot
Copy link
Contributor

Change https://go.dev/cl/589216 mentions this issue: doc/next: document proposal 62518 as not relevant

gopherbot pushed a commit that referenced this issue May 30, 2024
For #65614.

Change-Id: I03dc3a46052f1e55dc1ab46b45c886c96c4a1b39
Reviewed-on: https://go-review.googlesource.com/c/go/+/589216
TryBot-Bypass: Dmitri Shuralyov <[email protected]>
Reviewed-by: Matthew Dempsky <[email protected]>
Auto-Submit: Dmitri Shuralyov <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
gopherbot pushed a commit that referenced this issue May 30, 2024
This change adds a preannouncement to the release notes. Go 1.24
will require the Linux kernel to be at version 3.17 or later,
with an exception that systems running 3.10 or later will
continue to be supported if the kernel has been patched to
support the getrandom system call.

For #65614
For #67001

Change-Id: I61a3838b9ce4f48eb9f94830aa03372d589afdcd
Reviewed-on: https://go-review.googlesource.com/c/go/+/589015
LUCI-TryBot-Result: Go LUCI <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/590616 mentions this issue: doc: document "range-over-func" language change in release notes

gopherbot pushed a commit that referenced this issue Jun 11, 2024
For #65614.
Updates #67401.

Change-Id: Ib38c134ea7ffc69434c79600ba75185e02809d0f
Reviewed-on: https://go-review.googlesource.com/c/go/+/591898
LUCI-TryBot-Result: Go LUCI <[email protected]>
Reviewed-by: Than McIntosh <[email protected]>
gopherbot pushed a commit that referenced this issue Jun 11, 2024
For #65614.
Updates #60905.

Change-Id: I2dd9df3c7066357cf06268d918bad3c255b38aed
Reviewed-on: https://go-review.googlesource.com/c/go/+/591875
LUCI-TryBot-Result: Go LUCI <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
Reviewed-by: Joel Sing <[email protected]>
gopherbot pushed a commit that referenced this issue Jun 11, 2024
For #65614.
Updates #61476.

Change-Id: Id677aa6d2a59366ab75a26f08a383d2d253f270e
Reviewed-on: https://go-review.googlesource.com/c/go/+/591895
LUCI-TryBot-Result: Go LUCI <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
Reviewed-by: Joel Sing <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
@dmitshur
Copy link
Contributor Author

dmitshur commented Jun 12, 2024

Rerunning relnote todo today doesn't find more TODOs beyond the 4 already added to the source (view-source:https://tip.golang.org/doc/go1.23).

relnote todo output
$ cd gotip 
gotip $ git status
On branch main
Your branch is up to date with 'origin/master'.

nothing to commit, working tree clean
gotip $ git pull --ff-only 
Already up to date.

gotip $ go run golang.org/x/build/cmd/relnote@latest -goroot=. todo
relnote: collecting TODOs from . since 2024-01-19
[...]
<!-- TODO: Improve the wording. Mention the tlskyber GODEBUG. --> (from 6-stdlib/99-minor/crypto/tls/67061.md:1)
<!-- TODO: Improve this if needed. --> (from 3-tools.md:22)
<!-- TODO: document Go 1.23 behavior (from https://go.dev/cl/559199, https://go.dev/cl/559519, https://go.dev/cl/559795, https://go.dev/cl/562715, https://go.dev/cl/562735, https://go.dev/cl/564555, https://go.dev/cl/570679, https://go.dev/cl/570736, https://go.dev/cl/582695, https://go.dev/cl/584276, https://go.dev/cl/585235, https://go.dev/cl/586138) --> (from 3-tools.md:34)
<!-- TODO: document Go 1.23 behavior (from https://go.dev/cl/584218, https://go.dev/cl/584300, https://go.dev/cl/584475, https://go.dev/cl/584476) --> (from 3-tools.md:37)

@gopherbot
Copy link
Contributor

Change https://go.dev/cl/592195 mentions this issue: doc/next: reword map iterator function notes

@gopherbot
Copy link
Contributor

Change https://go.dev/cl/592196 mentions this issue: doc/next: improve wording for proposal 67061

@gopherbot
Copy link
Contributor

Change https://go.dev/cl/592197 mentions this issue: doc/next: improve description of proposal 61308

gopherbot pushed a commit that referenced this issue Jun 12, 2024
The notes don't define identifiers m and seq. Describe in words
instead.

While here, rename 3-structs.md to 4-structs.md.

For #65614.

Change-Id: I6690f552903d1870c70e28673c87ac84b7c5c041
Reviewed-on: https://go-review.googlesource.com/c/go/+/592195
Reviewed-by: Ian Lance Taylor <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>
gopherbot pushed a commit that referenced this issue Jun 12, 2024
For #61308.
For #65614.

Change-Id: I36b4f2392075d5a3fb9f53a28bd19b997e7be363
Reviewed-on: https://go-review.googlesource.com/c/go/+/592197
Reviewed-by: Ian Lance Taylor <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
TryBot-Bypass: Dmitri Shuralyov <[email protected]>
gopherbot pushed a commit that referenced this issue Jun 18, 2024
For #67061.
For #65614.

Change-Id: I0e324b02537e0d40c2092139d31941a1a85a0e69
Reviewed-on: https://go-review.googlesource.com/c/go/+/592196
Reviewed-by: Roland Shoemaker <[email protected]>
Auto-Submit: Dmitri Shuralyov <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
TryBot-Bypass: Dmitri Shuralyov <[email protected]>
gopherbot pushed a commit that referenced this issue Jun 18, 2024
For #65614

Change-Id: I6274bdaba970cfb085af500fdaf8ed078202bfdc
Reviewed-on: https://go-review.googlesource.com/c/go/+/591380
Reviewed-by: David Chase <[email protected]>
Reviewed-by: Russ Cox <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/593495 mentions this issue: doc/next: update release notes for go list -m -json

gopherbot pushed a commit that referenced this issue Jun 18, 2024
For #65614

Change-Id: I49921aefb79efbc012e745cc2abd9ff36c0a9149
Reviewed-on: https://go-review.googlesource.com/c/go/+/593495
Reviewed-by: Dmitri Shuralyov <[email protected]>
Auto-Submit: Sam Thanawalla <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
@dmitshur
Copy link
Contributor Author

dmitshur commented Jun 18, 2024

The Go 1.23 Release Notes draft is complete, and all known TODOs have been resolved. Running relnote todo right now doesn't find anything remaining beyond proposal #61940, which doesn't need to be mentioned. Adding okay-after-rc1.

This issue now tracks the remaining post-RC 1 work:

  • any additional copy-editing and other improvements
  • merge fragments and move draft to x/website (CL 594035 + CL 594036)
  • on the Go 1.23.0 release day, remove the draft notice

@dmitshur dmitshur added the okay-after-rc1 Used by release team to mark a release-blocker issue as okay to resolve either before or after rc1 label Jun 18, 2024
@gopherbot gopherbot removed the okay-after-rc1 Used by release team to mark a release-blocker issue as okay to resolve either before or after rc1 label Jun 21, 2024
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/594035 mentions this issue: _content/doc: add merged go1.23.md

gopherbot added a commit to golang/website that referenced this issue Jun 21, 2024
Using doc/next content as of 2024-06-21 (commit 1b4f1dc95d221c1e9d0afb9067fd6a09f12dd061).

For golang/go#65614.

Change-Id: Ifa21855a92dc99f480ea605947cc48d542ff5193
Reviewed-on: https://go-review.googlesource.com/c/website/+/594035
Auto-Submit: Gopher Robot <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>
Reviewed-by: David Chase <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/594036 mentions this issue: doc/next: delete

gopherbot added a commit that referenced this issue Jun 21, 2024
The release note fragments have been merged and added
as _content/doc/go1.23.md in x/website in CL 594035.

For #65614.

Change-Id: I7c8c718bc065024b6bdca93ce9bcc3c5d8b2dbc7
Reviewed-on: https://go-review.googlesource.com/c/go/+/594036
LUCI-TryBot-Result: Go LUCI <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
Auto-Submit: Dmitri Shuralyov <[email protected]>
Reviewed-by: David Chase <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/595959 mentions this issue: _content/doc/go1.23: remove minor package changes with no content

gopherbot pushed a commit to golang/website that referenced this issue Jul 2, 2024
Some packages (iter, maps, structs, and unique) are mentioned in
the "Core library" section and there is no content (except
comments) in the "Minor changes" section for them. Remove.

For golang/go#65614.

Change-Id: I9989b83e5cb9893c1d5aa90b36035d797916ae8e
Reviewed-on: https://go-review.googlesource.com/c/website/+/595959
LUCI-TryBot-Result: Go LUCI <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
Reviewed-by: Than McIntosh <[email protected]>
Mchnan pushed a commit to Mchnan/go-sylixos that referenced this issue Jul 9, 2024
The release note fragments have been merged and added
as _content/doc/go1.23.md in x/website in CL 594035.

For golang#65614.

Change-Id: I7c8c718bc065024b6bdca93ce9bcc3c5d8b2dbc7
Reviewed-on: https://go-review.googlesource.com/c/go/+/594036
LUCI-TryBot-Result: Go LUCI <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
Auto-Submit: Dmitri Shuralyov <[email protected]>
Reviewed-by: David Chase <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/599775 mentions this issue: _content/doc/go1.23: minor format change

gopherbot pushed a commit to golang/website that referenced this issue Jul 22, 2024
For golang/go#65614.

Change-Id: Iecdebfaf4e7467734e60f30867ebcf926e31e97b
Reviewed-on: https://go-review.googlesource.com/c/website/+/599775
Reviewed-by: Dmitri Shuralyov <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/600936 mentions this issue: _content/doc/go1.23: document known issue for generic alias types

gopherbot pushed a commit to golang/website that referenced this issue Jul 25, 2024
For golang/go#68526.
For golang/go#65614.

Change-Id: I260da94ffaae0d6583e6396b0a78b46dd298313c
Reviewed-on: https://go-review.googlesource.com/c/website/+/600936
Reviewed-by: Ian Lance Taylor <[email protected]>
Reviewed-by: Tim King <[email protected]>
Reviewed-by: Robert Griesemer <[email protected]>
TryBot-Bypass: Robert Griesemer <[email protected]>
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/601995 mentions this issue: _content/doc/go1.23: fix a typo and some formatting

gopherbot pushed a commit to golang/website that referenced this issue Jul 31, 2024
Updates golang/go#65614

Change-Id: I46b53e25a3f81aaecbdef74f02bcafd341530b23
Reviewed-on: https://go-review.googlesource.com/c/website/+/601995
Auto-Submit: Brad Fitzpatrick <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
Reviewed-by: Michael Knyszek <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation NeedsFix The path to resolution is known, but the work has not been done. release-blocker
Projects
Status: In Progress
Development

No branches or pull requests

4 participants