blob: 9f70ea952eda0534f7143f93913e6e91f1836c9f [file] [log] [blame] [view]
Jonathan Amsterdamb3cfb242023-11-15 08:23:23 -05001# Release Notes
2
3The `initial` and `next` subdirectories of this directory are for release notes.
4
Jonathan Amsterdam6037c8a2024-01-22 13:20:07 -05005## For developers
6
Jonathan Amsterdamb3cfb242023-11-15 08:23:23 -05007Release notes should be added to `next` by editing existing files or creating new files.
8
Jonathan Amsterdam6037c8a2024-01-22 13:20:07 -05009At the end of the development cycle, the files will be merged by being
10concatenated in sorted order by pathname. Files in the directory matching the
11glob "*stdlib/*minor" are treated specially. They should be in subdirectories
12corresponding to standard library package paths, and headings for those package
13paths will be generated automatically.
Jonathan Amsterdamb3cfb242023-11-15 08:23:23 -050014
Jonathan Amsterdam6037c8a2024-01-22 13:20:07 -050015Files in this repo's `api/next` directory must have corresponding files in
16`*stdlib/*minor`. The files should be in the subdirectory for the package with
17the new API, and should be named after the issue number of the API proposal. For
18example, an `api/next` file with the line
Jonathan Amsterdamb3cfb242023-11-15 08:23:23 -050019
20 pkg net/http, function F #12345
21
Jonathan Amsterdam6037c8a2024-01-22 13:20:07 -050022should have a corresponding file named `net/http/12345.md`.
Jonathan Amsterdamb3cfb242023-11-15 08:23:23 -050023At a minimum, that file should contain either a full sentence or a TODO,
24ideally referring to a person with the responsibility to complete the note.
Jonathan Amsterdam6037c8a2024-01-22 13:20:07 -050025
26## For the release team
27
28At the start of a release development cycle, the contents of `next` should be deleted
29and replaced with those of `initial`. From the repo root:
30
31 > cd doc
32 > rm -r next/*
33 > cp -r initial/* next
34
35Then edit `next/1-intro.md` to refer to the next version.
36
37To prepare the release notes for a release, run `golang.org/x/build/cmd/relnote generate`.
38That will merge the `.md` files in `next` into a single file.