Skip to content

Latest commit

 

History

History
 
 

_release-content

README.md

Release Content

This directory contains drafts of documentation for the current development cycle, which will be published to the website during the next release. You can find more information in the release notes and migration guides files.

Publishing

When it is time to start preparing the final release notes / migration guide over in bevy-website, use the following process:

  1. Check out the upcoming Bevy release branch in the bevy repo
  2. Open a terminal, navigate to the tools/export-content folder in the bevy repo, and run cargo run.
  3. Use the tool to easily reorder the release notes relative to each other
  4. After saving and exiting the tool, it will write merged_release_notes.md and merged_migration_guides.md to _release-content
  5. Use these to create a release notes news article draft and a migration guide draft in bevy-website.