Skip to content

Commit cf35e10

Browse files
Extend release notes to include "announce"
This accommodates a new release notes tag "announce" which will be included in the "Announcements" sections of the release notes. Documentation is updated accordingly to accommodate it.
1 parent 1251721 commit cf35e10

File tree

4 files changed

+20
-4
lines changed

4 files changed

+20
-4
lines changed

doc/_pages/release_playbook.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,10 @@ the main body of the document:
6868
not the "Multibody" heading.
6969
* Expand all acronyms (eg, MBP -> MultibodyPlant, SG -> SceneGraph).
7070
* Commits can be omitted if they only affect tests or non-installed examples. {% comment %}TODO(jwnimmer-tri) Explain how to check if something is installed.{% endcomment %}
71-
* PRs that are tagged with release deprecation information _may_ appear twice.
72-
They will be included once in the appropriate deprecation-related section
73-
according to the deprecation tag. But they may also appear in their topical
74-
section if they also include a tag such as "fix" or "feature".
71+
* PRs may appear in multiple sections, depending on the tags they have. For
72+
example, a PR that includes a fix and new deprecation will appear in both the
73+
fix and newly-deprecated sections. Generally, PRs will be included once in
74+
each appropriate section according to the tags assigned to it.
7575
* In general you should mention deprecated/removed classes and methods using
7676
their exact name (for easier searching).
7777
* In the deprecation section you can provide the fully-qualified name as the

doc/_pages/reviewable.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,16 @@ notes: feature`` or ``release notes: fix`` is fine; in the
120120
case of externals bumps, the notes document doesn't use separate
121121
sections for fix / feature anyway.
122122

123+
**release notes: announce**<br/>
124+
125+
Drake release notes will frequently highlight specific changes in its
126+
"Announcements" section. If a PR author (or subsequent reviewer) feels that
127+
the PR's change should be included in the announcements, they can add this tag
128+
to call the release engineer's attention to it. This is a helpful aid to the
129+
release engineer, but, at the end of the day, the release engineer has
130+
discretion to include PRs in announcements that have not been tagged and even
131+
omit PRs that _have_ been tagged.
132+
123133
**When combining release notes labels:**
124134

125135
- ``none`` must not be combined with any other label.
@@ -129,6 +139,9 @@ sections for fix / feature anyway.
129139
because usually the deprecation is concurrent with the addition of its
130140
replacement or due to some other new change. Only if the deprecation is the
131141
_sole_ content of the commit will ``newly deprecated`` be the only label.
142+
- ``announce`` will generally be combined with another label -- presumably the
143+
label characterizing the nature of a change being announced. Most typically,
144+
it will be partnered with a ``feature`` or ``fix`` label.
132145

133146
# Joint Feature and Platform review
134147

doc/_release-notes/template.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ released: YYYY-MM-DD
77

88
# Announcements
99

10+
<!-- <relnotes for announcements go here> -->
11+
1012
* None
1113

1214
# Breaking changes since v{prior_version}

tools/release_engineering/relnotes.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -311,6 +311,7 @@ def _update(args, notes_filename, gh, drake, target_commit):
311311
"breaking change": "breaking-changes",
312312
"newly deprecated": "newly-deprecated",
313313
"removal of deprecated": "deprecated-removed",
314+
"announce": "announcements",
314315
}
315316
primary_used = False
316317
for severity in severities:

0 commit comments

Comments
 (0)