qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-09-29 01:24:34 -06:00
Code Releases Activity

doc/README.md: explain new release note system

Browse Source 
This is the first CL in a sequence that adds support
for generating release notes from fragments.

The actual generator will live elsewhere, in x/build.
This repo will hold the content and some validity
checks.

For #64169.

Change-Id: Iaa8d9ad96393ab9433170b3cfa47334837f3f691
Reviewed-on: https://go-review.googlesource.com/c/go/+/542515
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
This commit is contained in:
Jonathan Amsterdam 2023-11-15 08:23:23 -05:00
parent 558919b454
commit b3cfb24f8d
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/README.md Normal file
View File

@ -0,0 +1,26 @@
# Release Notes
The `initial` and `next` subdirectories of this directory are for release notes.
At the start of a release development cycle, the contents of `next` should be deleted
and replaced with those of `initial`.
Release notes should be added to `next` by editing existing files or creating new files.
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.
The files are 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 `*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, for an api/next
file with the line
pkg net/http, function F #12345
there should be a file named 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.