Skip to content

Commit d4184eb

Browse files
committed
docs: Setup template for release note process
Add some guidelines for release notes that developers can use to create release note snippets as features and fixes are implemented. This will greatly reduce the work needed at release time. Signed-off-by: David Brown <david.brown@linaro.org>
1 parent 1090d8f commit d4184eb

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed

docs/release-notes.d/00readme.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Pending release notes directory
2+
3+
This directory contains release note entries that have not been merged
4+
into the main release-notes.md document.
5+
6+
Generally a release note entry should be created for changes that:
7+
8+
- Fix bugs in the code.
9+
- Implement new features.
10+
- Change existing behavior.
11+
12+
Release notes are generally not needed for:
13+
14+
- Some documentation improvements.
15+
- Strictly internal changes to the code that won't be visible to users
16+
of the code.
17+
18+
## Release note format
19+
20+
Release notes are included in files under this `docs/release-notes.d`
21+
directory and have a name of `*.md`. They will be included in the
22+
`release-notes.md` file, and should be formatted as a Markdown list
23+
entry. (A script will be developed to collect these, ordered by when
24+
the commits were added to the tree.)
25+
26+
Choose a filename that is related to what this change does. The names
27+
are not used for anything in particular, but to keep the files
28+
distinct so that there isn't a concern with merge conflicts as
29+
different pull requests merge in different orders.

docs/release.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@ Before making a release, update the `docs/release-notes.md` file
2424
to describe the release. This should be a high-level description of
2525
the changes, not a list of the git commits.
2626

27+
Provided that changes going into the release have followed the
28+
contribution guidelines, this should mostly consist of collecting the
29+
various snippets in the `docs/release-notes.d` directory. After
30+
incorporating these snippets into the release notes, the snippet files
31+
should be removed to ready the directory for the next release cycle.
32+
2733
## Release candidates
2834

2935
Before each release, tags are made (see below) for at least one

0 commit comments

Comments
 (0)