Skip to content

Commit 6a87f1f

Browse files
authored
Update release notes template (#1884)
1 parent 9efcc37 commit 6a87f1f

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

src/handlers/relnotes.rs

+13-13
Original file line numberDiff line numberDiff line change
@@ -75,36 +75,36 @@ pub async fn handle(ctx: &Context, event: &Event) -> anyhow::Result<()> {
7575
"
7676
This issue tracks the release notes text for #{}.
7777
78-
### Steps
78+
cc {} -- original issue/PR authors and assignees for drafting text
7979
80-
- [ ] Proposed text is drafted by PR author (or team) making the noteworthy change.
81-
- [ ] Issue is nominated for release team review of clarity for wider audience.
82-
- [ ] Release team includes text in release notes/blog posts.
80+
See the forge.rust-lang.org chapter about [release notes](https://forge.rust-lang.org/release/release-notes.html#preparing-release-notes) for an overview of how the release team makes use of these tracking issues.
8381
8482
### Release notes text
8583
86-
The responsible team for the underlying change should edit this section to replace the automatically generated link with a succinct description of what changed, drawing upon text proposed by the author (either in discussion or through direct editing).
84+
This section should be edited to specify the correct category(s) for the change, with succinct description(s) of what changed. Some things worth considering:
85+
- Does this need an additional compat notes section?
86+
- Was this a libs stabilization that should have additional headers to list new APIs under `Stabilized APIs` and `Const Stabilized APIs`?
87+
8788
8889
````markdown
89-
# Category (e.g. Language, Compiler, Libraries, Compatibility notes, ...)
90+
# Language/Compiler/Libraries/Stabilized APIs/Const Stabilized APIs/Rustdoc/Compatibility Notes/Internal Changes/Other
9091
- [{}]({})
9192
````
9293
9394
> [!TIP]
94-
> Use the [previous releases](https://doc.rust-lang.org/nightly/releases.html) categories to help choose which one(s) to use.
95-
> The category will be de-duplicated with all the other ones by the release team.
96-
>
97-
> *More than one section can be included if needed.*
95+
> Use the [previous releases](https://doc.rust-lang.org/nightly/releases.html) for inspiration on how to write the release notes text and which categories to pick.
9896
9997
### Release blog section
10098
101-
If the change is notable enough for inclusion in the blog post, the responsible team should add content to this section.
102-
*Otherwise leave it empty.*
99+
If this change is notable enough for inclusion in the blog post then this section should be edited to contain a draft for the blog post. *Otherwise leave it empty.*
100+
103101
104102
````markdown
105103
````
106104
107-
cc {} -- origin issue/PR authors and assignees for starting to draft text
105+
> [!NOTE]
106+
>
107+
> If a blog post section is required the `release-blog-post` label should be added (`@rustbot label +release-blog-post`) to this issue as otherwise it may be missed by the release team.
108108
",
109109
e.issue.number, e.issue.title, e.issue.html_url,
110110
[&e.issue.user].into_iter().chain(e.issue.assignees.iter())

0 commit comments

Comments
 (0)