Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Merged by Bors] - 0.8 Migration guide #389

Closed
wants to merge 51 commits into from

Conversation

IceSentry
Copy link
Contributor

@IceSentry IceSentry commented Jun 29, 2022

Objective

  • Migration guide for 0.8

Solution

  • Create a new section for each PR tagged with C-Breaking-Change
    • Copy the Migration Guide from the PR if it exists
  • Create a few more sections for PR not tagged with the label

Notes

The ordering was pretty much whatever order github gave me when I searched breaking changes, so if you feel like something should be close to the top please notify me. For example, I moved the camera driven stuff at the top since it's probably going to be the biggest one

@IceSentry IceSentry marked this pull request as draft June 29, 2022 03:59
@hymm
Copy link
Contributor

hymm commented Jun 29, 2022

task pools changing to a global is probably a breaking change, but PR wasn't labeled as such
bevyengine/bevy#2250

@alice-i-cecile
Copy link
Member

Helping sort out confusion caused by changes to camera bundles from bevyengine/bevy#4745. This deserves top billing in terms of this version's migration guide.

Copy link
Contributor

@rparrett rparrett left a comment

Choose a reason for hiding this comment

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

Did a quick pass on the 0.8 code blocks for compilability.

content/learn/book/migration-guides/0.7-0.8/_index.md Outdated Show resolved Hide resolved
content/learn/book/migration-guides/0.7-0.8/_index.md Outdated Show resolved Hide resolved
content/learn/book/migration-guides/0.7-0.8/_index.md Outdated Show resolved Hide resolved
content/learn/book/migration-guides/0.7-0.8/_index.md Outdated Show resolved Hide resolved
content/learn/book/migration-guides/0.7-0.8/_index.md Outdated Show resolved Hide resolved
content/learn/book/migration-guides/0.7-0.8/_index.md Outdated Show resolved Hide resolved
@rparrett
Copy link
Contributor

@afonsolage

The section in the migration guide for your PR bevyengine/bevy#5210 could probably use some work, but I don't understand reflection enough to help. It's currently just using the Changelog section from the PR, but this doesn't really seem to give any actionable advice for a user migrating their code.

Would you mind helping out here?

https://github.com/bevyengine/bevy-website/blob/bfcc0e2538bffddf21107b96f66bc2e681c7ebf4/content/learn/book/migration-guides/0.7-0.8/_index.md#make-reflect_partial_eq-return-more-accurate-results

Copy link
Contributor

@rparrett rparrett left a comment

Choose a reason for hiding this comment

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

Did a pass on the code blocks with the goal of formatting them consistently

content/learn/book/migration-guides/0.7-0.8/_index.md Outdated Show resolved Hide resolved
content/learn/book/migration-guides/0.7-0.8/_index.md Outdated Show resolved Hide resolved
content/learn/book/migration-guides/0.7-0.8/_index.md Outdated Show resolved Hide resolved
content/learn/book/migration-guides/0.7-0.8/_index.md Outdated Show resolved Hide resolved
content/learn/book/migration-guides/0.7-0.8/_index.md Outdated Show resolved Hide resolved
Copy link
Contributor

@afonsolage afonsolage left a comment

Choose a reason for hiding this comment

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

@rparrett sure, I'm not native, so I may not find the correct words to have a good migration guide, but here is what this PR does with more details

content/learn/book/migration-guides/0.7-0.8/_index.md Outdated Show resolved Hide resolved
@aevyrie
Copy link
Member

aevyrie commented Jul 26, 2022

Added some content in a PR: IceSentry#4

Copy link
Member

@cart cart left a comment

Choose a reason for hiding this comment

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

Great work everyone!

@cart
Copy link
Member

cart commented Jul 30, 2022

bors r+

bors bot pushed a commit that referenced this pull request Jul 30, 2022
## Objective

- Migration guide for 0.8

## Solution

- Create a new section for each PR tagged with `C-Breaking-Change`
	- Copy the Migration Guide from the PR if it exists
- Create a few more sections for PR not tagged with the label

## Notes

The ordering was pretty much whatever order github gave me when I searched breaking changes, so if you feel like something should be close to the top please notify me. For example, I moved the camera driven stuff at the top since it's probably going to be the biggest one

Co-authored-by: Charles <[email protected]>
@bors
Copy link

bors bot commented Jul 30, 2022

Pull request successfully merged into master.

Build succeeded:

@bors bors bot changed the title 0.8 Migration guide [Merged by Bors] - 0.8 Migration guide Jul 30, 2022
@bors bors bot closed this Jul 30, 2022
@IceSentry IceSentry deleted the 0.8-migration-guide branch August 17, 2022 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.