Skip to content

Add basic release content tagging workflow#18568

Merged
alice-i-cecile merged 10 commits intobevyengine:mainfrom
NthTensor:main
Mar 27, 2025
Merged

Add basic release content tagging workflow#18568
alice-i-cecile merged 10 commits intobevyengine:mainfrom
NthTensor:main

Conversation

@NthTensor
Copy link
Contributor

@NthTensor NthTensor commented Mar 27, 2025

Objective

This PR begins integrating the new releate-content drafting process (#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.

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?

@NthTensor NthTensor added C-Docs An addition or correction to our documentation S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Mar 27, 2025
@alice-i-cecile alice-i-cecile added A-Build-System Related to build systems or continuous integration A-Meta About the project itself labels Mar 27, 2025
@alice-i-cecile alice-i-cecile requested a review from BD103 March 27, 2025 04:48
Copy link
Contributor

@doup doup left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I checked it on your fork and the messages are looking good. Left a couple of suggestions for the templates for common issues when integrating with bevy-website.

Copy link
Member

@BD103 BD103 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just reviewed the CI, but it looks like it should work!

@NthTensor
Copy link
Contributor Author

NthTensor commented Mar 27, 2025

Since it's come up a few times, I want to mention that the tool I am writing to merge the notes together will ideally also translate H1 headings into H3 or whatever. This is pretty easy to do, and I've done it before. The rational is that the writers of individual notes really shouldn't have to know about the final structure, and it just makes things a bit more flexible.

@NthTensor NthTensor added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Mar 27, 2025
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Mar 27, 2025
Merged via the queue into bevyengine:main with commit 0a2e183 Mar 27, 2025
32 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-Build-System Related to build systems or continuous integration A-Meta About the project itself C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants