1
0
mirror of https://github.com/golang/go synced 2024-11-22 15:04:52 -07:00
go/doc
Austin Clements f9a95b1bdc cmd/go: print build errors during go test -json in JSON
Currently, if a test or imported package fails to build during "go
test -json", the build error text will be interleaved with the JSON
output of tests. Furthermore, there’s currently no way to reliably
associate a build error with the test package or packages it affected.
This creates unnecessary friction and complexity in tools that consume
the "go test -json" output.

This CL makes "go test -json" enable JSON reporting of build errors.
It also adds a "FailedBuild" field to the "fail" TestEvent, which
gives the package ID of the package that failed to build and caused
the test to fail.

Using this, CI systems should be able to consume the entire output
stream from "go test -json" in a structured way and easily associate
build failures with test failures during reporting.

Fixes #62067.
Updates #35169.
Updates #37486.

Change-Id: I49091dcc7aa52db01fc9fa6042771633e97b8407
Reviewed-on: https://go-review.googlesource.com/c/go/+/536399
Reviewed-by: Russ Cox <rsc@golang.org>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
2024-11-17 14:32:05 +00:00
..
initial doc/initial, doc/next: add draft notice to introduction 2024-05-22 18:25:26 +00:00
next cmd/go: print build errors during go test -json in JSON 2024-11-17 14:32:05 +00:00
asm.html
go1.17_spec.html doc: reference language version in pre-generic spec for easier recognition 2024-10-10 18:25:45 +00:00
go_mem.html doc/go_mem: fix broken paper link in go_mem.html 2024-11-12 17:16:27 +00:00
go_spec.html spec: document that alias declarations can have type parameters with 1.24 2024-10-02 00:58:01 +00:00
godebug.md Revert "crypto/rand: add randcrash=0 GODEBUG" 2024-10-28 14:46:33 +00:00
README.md doc: initialize next directory for Go 1.24 2024-07-22 17:55:04 +00:00

Release Notes

The initial and next subdirectories of this directory are for release notes.

For developers

Release notes should be added to next by editing existing files or creating new files. Do not add RELNOTE=yes comments in CLs. Instead, add a file to the CL (or ask the author to do so).

At the end of the development cycle, the files will be merged by being concatenated in sorted order by pathname. Files in the directory matching the glob "*stdlib/*minor" are treated specially. They should be in subdirectories corresponding to standard library package paths, and headings for those package paths will be generated automatically.

Files in this repo's api/next directory must have corresponding files in doc/next/*stdlib/*minor. The files should be in the subdirectory for the package with the new API, and should be named after the issue number of the API proposal. For example, if the directory 6-stdlib/99-minor is present, then an api/next file with the line

pkg net/http, function F #12345

should have a corresponding file named doc/next/6-stdlib/99-minor/net/http/12345.md. At a minimum, that file should contain either a full sentence or a TODO, ideally referring to a person with the responsibility to complete the note.

If your CL addresses an accepted proposal, mention the proposal issue number in your release note in the form /issue/NUMBER. A link to the issue in the text will have this form (see below). If you don't want to mention the issue in the text, add it as a comment:

<!-- go.dev/issue/12345 -->

If an accepted proposal is mentioned in a CL but not in the release notes, it will be flagged as a TODO by the automated tooling. That is true even for proposals that add API.

Use the following forms in your markdown:

[http.Request]                     # symbol documentation; auto-linked as in Go doc strings
[Request]                          # short form, for symbols in the package being documented
[net/http]                         # package link
[#12345](/issue/12345)             # GitHub issues
[CL 6789](/cl/6789)                # Gerrit changelists

To preview next content in merged form using a local instance of the website, run:

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

Then open http://localhost:6060/doc/next. Refresh the page to see your latest edits.

For the release team

The relnote tool, at golang.org/x/build/cmd/relnote, operates on the files in doc/next.

As a release cycle nears completion, run relnote todo to get a list of unfinished release note work.

To prepare the release notes for a release, run relnote generate. That will merge the .md files in next into a single file. Atomically (as close to it as possible) add that file to _content/doc directory of the website repository and remove the doc/next directory in this repository.

To begin the next release development cycle, populate the contents of next with those of initial. From the repo root:

> cd doc
> cp -R initial/ next

Then edit next/1-intro.md to refer to the next version.