0a2e183476
# Objective This PR begins integrating the new releate-content drafting process (https://github.com/bevyengine/bevy/pull/18427) into our GitHub workflows. It's similar to what we had before: Messages are posted to PRs tagged with `M-Needs-Release-Note` or `M-Needs-Migration-Guide` asking them to add the required material and linking to the instructions. These messages do not trigger if the PR already has modified files in the `release-notes` or `migration-guides` directories (respectively). I have also re-arranged and content slightly (to remove the need for a directory with the current version number), tweaked the language, and switched the templates to use the [standard markdown frontmatter format](https://jekyllrb.com/docs/front-matter/). ## Reviewer Questions + Do we want to add a CI rule actually requiring tagged PRs to create/modify files in the correct directories, or is the message prompt enough? + Do we want to add a CI rule to lint the metadata, for example to enforce that the PR number is included in the files it modifies?
20 lines
579 B
Markdown
20 lines
579 B
Markdown
---
|
|
title: Feature name
|
|
authors: ["@FerrisTheCrab", "@BirdObsessed"]
|
|
pull_requests: [14791, 15458, 15269]
|
|
---
|
|
|
|
Copy the contents of this file into `./release-notes`, update the metadata, and add release note content here.
|
|
|
|
## Goals
|
|
|
|
Answer the following:
|
|
|
|
- What has been changed or added?
|
|
- Why is this a big deal for users?
|
|
- How can they use it?
|
|
|
|
## Style Guide
|
|
|
|
You may use markdown headings levels two and three, and must not start with a heading. Prose is appreciated, but bullet points are acceptable. Copying the introduction from your PR is often a good place to start.
|