0e7f5cf30b
Release notes should always be files under doc/next. Make it clear that this is the only way to add them: RELNOTE markers in CLs are no longer supported. Change-Id: I34d77eb876f57b84ecdc7e5ecbf3eb5c91e6fed8 Reviewed-on: https://go-review.googlesource.com/c/go/+/582075 Reviewed-by: Dmitri Shuralyov <dmitshur@google.com> TryBot-Bypass: Jonathan Amsterdam <jba@google.com> Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
1.9 KiB
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.
Use the following forms in your markdown:
[http.Request] # symbol documentation; auto-linked as in Go doc strings
[#12345](/issue/12345) # GitHub issues
[CL 6789](/cl/6789) # Gerrit changelists
For the release team
At the start of a release development cycle, the contents of next should be deleted
and replaced 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.
To prepare the release notes for a release, run golang.org/x/build/cmd/relnote generate.
That will merge the .md files in next into a single file.