614f2284d9
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 <jba@google.com> Reviewed-by: Dmitri Shuralyov <dmitshur@google.com> TryBot-Bypass: Dmitri Shuralyov <dmitshur@golang.org> Auto-Submit: Dmitri Shuralyov <dmitshur@golang.org> |
||
|---|---|---|
| .. | ||
| initial | ||
| next | ||
| asm.html | ||
| go1.17_spec.html | ||
| go_mem.html | ||
| go_spec.html | ||
| godebug.md | ||
| README.md | ||
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
[#12345](/issue/12345) # GitHub issues
[CL 6789](/cl/6789) # Gerrit changelists
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.
To begin the next release development cycle, delete the contents of next
and replace them with those of initial. From the repo root:
> cd doc
> rm -r next/*
> cp -r initial/* next
Then edit next/1-intro.md to refer to the next version.