| Jonathan Amsterdam | b3cfb24 | 2023-11-15 08:23:23 -0500 | [diff] [blame^] | 1 | # Release Notes |
| 2 | |
| 3 | The `initial` and `next` subdirectories of this directory are for release notes. |
| 4 | |
| 5 | At the start of a release development cycle, the contents of `next` should be deleted |
| 6 | and replaced with those of `initial`. |
| 7 | Release notes should be added to `next` by editing existing files or creating new files. |
| 8 | |
| 9 | To prepare the release notes for a release, run `golang.org/x/build/cmd/relnote generate`. |
| 10 | That will merge the `.md` files in `next` into a single file. |
| 11 | |
| 12 | The files are merged by being concatenated in sorted order by pathname. Files in |
| 13 | the directory matching the glob "*stdlib/*minor" are treated specially. They should |
| 14 | be in subdirectories corresponding to standard library package paths, and headings |
| 15 | for those package paths will be generated automatically. |
| 16 | |
| 17 | Files in this repo's `api/next` directory must have corresponding files in `*stdlib/*minor`. |
| 18 | The files should be in the subdirectory for the package with the new API, and should |
| 19 | be named after the issue number of the API proposal. For example, for an api/next |
| 20 | file with the line |
| 21 | |
| 22 | pkg net/http, function F #12345 |
| 23 | |
| 24 | there should be a file named net/http/12345.md. |
| 25 | At a minimum, that file should contain either a full sentence or a TODO, |
| 26 | ideally referring to a person with the responsibility to complete the note. |
