golang/go

doc: write release notes for Go 1.24

dmitshur opened this issue · 43 comments

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

When the Go 1.24 Release Notes are complete, this should be closed, and a similar issue should be made for the next release. The previous issue was #65614.

A partial list of changes that were known on 2024-11-26 to need to be added the release notes:

Change https://go.dev/cl/600177 mentions this issue: doc: initialize next directory for Go 1.24

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

Change https://go.dev/cl/600656 mentions this issue: doc/next: use relative link to Go issue

Change https://go.dev/cl/605615 mentions this issue: doc/next: document version stamping for go builds within a Git Repo

Change https://go.dev/cl/622015 mentions this issue: doc/next: document the minimum Linux kernel version for 1.24

Change https://go.dev/cl/631682 mentions this issue: doc/next: add release note for vet on Printf(s) with non-const s

Change https://go.dev/cl/631684 mentions this issue: doc/next: update with reviewed output from relnote todo

Change https://go.dev/cl/632055 mentions this issue: doc/next: document new language feature (alias type parameters)

Change https://go.dev/cl/632195 mentions this issue: doc/next: organize 9-todo.md items by category

Change https://go.dev/cl/633282 mentions this issue: doc/next: minor grammar fix in release notes

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

Change https://go.dev/cl/633599 mentions this issue: doc/next: add release notes for runtime and sync

Change https://go.dev/cl/633875 mentions this issue: doc/next: add linker change release notes

Change https://go.dev/cl/634036 mentions this issue: doc/next: add release notes for Wasm changes

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

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

Change https://go.dev/cl/634076 mentions this issue: _content/doc/go1.24: remove empty headings for new packages

Change https://go.dev/cl/634077 mentions this issue: _content/doc/go1.24: document broken windows/arm port

Change https://go.dev/cl/633856 mentions this issue: _content/doc: add release notes for version stamping go builds

Change https://go.dev/cl/634235 mentions this issue: _content/doc: add release notes for GOAUTH

Change https://go.dev/cl/634275 mentions this issue: _content/doc: add release notes for toolchaintrace

Change https://go.dev/cl/634798 mentions this issue: _content/doc/go1.24: minor updates

Change https://go.dev/cl/634797 mentions this issue: _content/doc/go1.24: improve hash/maphash release notes

Change https://go.dev/cl/635275 mentions this issue: _content/doc: update runtime.AddCleanup note

Change https://go.dev/cl/635216 mentions this issue: _content/doc/go1.24: remove release-blocking issues that are resolved

Change https://go.dev/cl/635340 mentions this issue: _content/doc/go1.24: use backticks for GOAUTH

Change https://go.dev/cl/635595 mentions this issue: _content/doc/go1.24: extend, fix, and cleanup crypto release notes

Change https://go.dev/cl/635597 mentions this issue: _content/doc/go1.24: normalize how GODEBUG settings are referred to

Change https://go.dev/cl/635598 mentions this issue: _content/doc/go1.24: reword VCS version stamping note

Change https://go.dev/cl/635596 mentions this issue: _content/doc/go1.24: minor nits

Thanks to everybody who have worked diligently to complete this draft of the release notes.

The Go 1.24 Release Notes draft is complete, and all known TODOs have been resolved. Adding okay-after-rc1.

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

  • Any additional copy-editing and other improvements.
    • Not in the release notes but documentation related: improvements to encoding documentation.
  • On the Go 1.24.0 release day, remove the draft notice.

Change https://go.dev/cl/636519 mentions this issue: _content/doc/go1.24: add objdump updates

Change https://go.dev/cl/638296 mentions this issue: _content/doc/go1.24: fix meaning of -u in 'go get -u tool'

Change https://go.dev/cl/638296 reads

There are various other details that could be covered, like the -u or -t
flags, or that 'go get tool' is a shorthand for 'go get tool@upgrade',

Using

go help get | grep "@upgrade"

Does not show anything. Yet

go get all@upgrade

does execute. Is anything missing from the docs regarding @upgrade in general?

@andig The go help get text describes the go get command and provides help on using it, but it doesn't attempt to provide complete coverage for all details. For that, it refers the reader to reference documentation:

$ go help get | grep '[Ss]ee'
See https://golang.org/ref/mod#go-get for details.
See 'go help install' or https://golang.org/ref/mod#go-install for details.
For more about build flags, see 'go help build'.
For more about modules, see https://golang.org/ref/mod.
suggested Go toolchain, see https://go.dev/doc/toolchain.
For more about specifying packages, see 'go help packages'.
See 'go help gopath-get'.
See also: go build, go install, go clean, go mod.

In this case, the https://go.dev/ref/mod#go-get section of the Go module reference is where the @upgrade version query suffix is documented, with that section itself also linking to https://go.dev/ref/mod#version-queries for remaining details.

The release notes still have TODO comments

<!-- #### [`crypto/fips140`](/pkg/crypto/fips140/)

TODO: FIPS 140 will be covered in its own section.
TODO: accepted [proposal #70200](/issue/70200) (from [CL 629196](/cl/629196), [CL 629198](/cl/629198), [CL 629201](/cl/629201), [CL 629996](/cl/629996))
TODO: crypto/tls FIPS mode from CL 629675. -->

which are not addressed.

Currently there is no mentioning of FIPS 140 (or fips140) in the release notes.

@FiloSottile @rolandshoemaker @rsc could you help write this? Thanks!

Currently there is no mentioning of FIPS 140 (or fips140) in the release notes.

@FiloSottile @rolandshoemaker @rsc could you help write this? Thanks!

Yep, will mail today or early tomorrow.

Change https://go.dev/cl/647856 mentions this issue: _content/doc/go1.24: clean up the "Maybe worth including" section

Change https://go.dev/cl/647855 mentions this issue: _content/doc/go1.24: don't refer to parameter names in release notes

Change https://go.dev/cl/647797 mentions this issue: _content/doc/go1.24: remove draft notice

Change https://go.dev/cl/648498 mentions this issue: cmd/golangorg, internal/history: update for Go 1.24.0 release