[Merged by Bors] - Migration guide 0.9-0.10 #530

IceSentry · 2023-02-04T22:09:47Z

First draft of the 0.10 migration guide.

This is generated by #469 and then modified manually

Since this is easy to generate, I will re-generate it multiple time before release so changing the contents of guides is encouraged, but changing ordering should be done closer to release to avoid dealing with multiple conflicts.

For this migration guide, I added tags for areas of each PR, added a bit of spacing and a line for each heading

This is why there are some css files in this pr.

james7132

Should we consider a scheme for grouping/prioritizing certain changes? The ones that break builds are immediately obvious, but the behavioral/default changes, especially the ones that affect safety, seem like they deserve to be highlighted separately.

content/learn/book/migration-guides/0.9-0.10/_index.md

james7132 · 2023-02-05T01:18:09Z

content/learn/book/migration-guides/0.9-0.10/_index.md

+    <div class="migration-guide-area-tag">ECS</div>
+</div>
+
+- Safety invariants on `bevy_ptr` types’ `new` `byte_add` and `byte_offset` methods have been changed. All callers should re-audit for soundness.


Breaking changes to safety invariants seem like they could insidiously hard to find, and the consequences result in UB. Should we show some higher priority to these?

Right now, the only sort is by area and then by close date. I have no issue with changing ordering, although, I think this should keep the area ordering. So in this case, keep it close to other ECS related guides. As mentioned in another comment, I'd prefer waiting until closer to release before actually moving it so I'll leave the conversation opened.

content/learn/book/migration-guides/0.9-0.10/_index.md

TimJentzsch · 2023-02-08T20:08:14Z

GamepadEventRaw and GamepadEventType have been removed and do not appear in the migration guide

content/learn/book/migration-guides/0.9-0.10/_index.md

Co-authored-by: James Liu <contact@jamessliu.com>

more clean up fix pipeline rendering guide more guides todo clean up re-generate clean up trying out some new style style clean up update style re-generate manual clean up clean up clean up re generate headings and soft breaks

IceSentry · 2023-02-20T21:43:55Z

bors try

bors · 2023-02-20T21:59:09Z

try

Build failed:

build-website

afonsolage

Made a full pass on all changes. I wasn't able to check if all migration guides are correct, but I did what I could.

content/learn/book/migration-guides/0.9-0.10/_index.md

nicopap

When migrating to 0.10.0, I had to replace usage of

Before:

// cam: Camera
cam.target
  .get_render_target_info(&windows, &images)?
  .physical_size
  .as_vec2()

After:

// cam: Camera
cam.physical_viewport_size()?.as_vec2()

Not sure where this goes, but it's a change I had to do when migrating

james7132 · 2023-02-27T01:46:58Z

Just leaving a note here not to forget to add bevyengine/bevy#7778 if it gets merged before 0.10 is ready. It's not necessarily a breaking change, but it does document a new safety invariant that should be publicly documented in some way.

Co-authored-by: Edgar Geier <geieredgar@gmail.com> Co-authored-by: Afonso Lage <lage.afonso@gmail.com> Co-authored-by: TimJentzsch <TimJentzsch.github.com@timjen.net> Co-authored-by: Rob Parrett <robparrett@gmail.com>

Co-authored-by: ickshonpe <david.curthoys@googlemail.com> Co-authored-by: Rob Parrett <robparrett@gmail.com>

IceSentry · 2023-03-03T06:14:07Z

@nicopap it looks like all those functions still exists, so I'm not sure anything needs to be migrated.

content/learn/book/migration-guides/0.9-0.10/_index.md

Co-authored-by: Liam Gallagher <ljpgallagher@xtra.co.nz>

content/learn/book/migration-guides/0.9-0.10/_index.md

alice-i-cecile · 2023-03-04T15:02:05Z

content/learn/book/migration-guides/0.9-0.10/_index.md

+
+### [Remove `TextError::ExceedMaxTextAtlases(usize)` variant](https://github.com/bevyengine/bevy/pull/6796)
+
+<div class="migration-guide-area-tags">


Formatting is broken in the preview starting here. Is there an unclosed tag or something?

It seems to work correctly for me when running it with zola locally, do you have a screenshot?

alice-i-cecile · 2023-03-04T15:03:36Z

A lot of users have been asking about multiple fixed timesteps, so here's a suggestion to add a section.

Multiple fixed timesteps

Only one fixed timestep is supported. If you were relying on this functionality, you should swap to using timers, via the on_timer(MY_PERIOD) run condition.

Co-authored-by: JoJoJet <21144246+JoJoJet@users.noreply.github.com>

IceSentry · 2023-03-04T19:09:52Z

@alice-i-cecile do you know what PR is related to this change? Should I just add it to the schedule_v3 section?

alice-i-cecile · 2023-03-04T20:21:02Z

It was part of the ScheduleV3 rewrite. Just stick it in that section.

content/learn/book/migration-guides/0.9-0.10/_index.md

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>

content/learn/book/migration-guides/0.9-0.10/_index.md

Co-authored-by: Marco Buono <thecoreh@gmail.com>

…lines

cart

Great work yall! Another fantastic release :)

cart · 2023-03-04T23:59:49Z

bors r+

First draft of the 0.10 migration guide. This is generated by #469 and then modified manually Since this is easy to generate, I will re-generate it multiple time before release so changing the contents of guides is encouraged, but changing ordering should be done closer to release to avoid dealing with multiple conflicts. For this migration guide, I added tags for areas of each PR, added a bit of spacing and a line for each heading ![image](https://user-images.githubusercontent.com/8348954/216899165-6f99a25f-e32d-42a4-bad4-8e23c7aac366.png) This is why there are some css files in this pr. Co-authored-by: IceSentry <IceSentry@users.noreply.github.com> Co-authored-by: Carter Anderson <mcanders1@gmail.com>

bors · 2023-03-05T00:28:14Z

Pull request successfully merged into master.

Build succeeded:

james7132 reviewed Feb 5, 2023

View reviewed changes

IceSentry force-pushed the migration-guide-0.10 branch from cf5b834 to 7d5bb38 Compare February 6, 2023 06:29

TimJentzsch reviewed Feb 8, 2023

View reviewed changes

content/learn/book/migration-guides/0.9-0.10/_index.md Outdated Show resolved Hide resolved

TimJentzsch reviewed Feb 8, 2023

View reviewed changes

content/learn/book/migration-guides/0.9-0.10/_index.md Outdated Show resolved Hide resolved

ickshonpe reviewed Feb 11, 2023

View reviewed changes

content/learn/book/migration-guides/0.9-0.10/_index.md Outdated Show resolved Hide resolved

geieredgar reviewed Feb 14, 2023

View reviewed changes

content/learn/book/migration-guides/0.9-0.10/_index.md Outdated Show resolved Hide resolved

IceSentry and others added 4 commits February 18, 2023 15:20

generate migration guide

bffedbe

add area label

41264ae

Update content/learn/book/migration-guides/0.9-0.10/_index.md

0245c9e

Co-authored-by: James Liu <contact@jamessliu.com>

clean up

21f380a

more clean up fix pipeline rendering guide more guides todo clean up re-generate clean up trying out some new style style clean up update style re-generate manual clean up clean up clean up re generate headings and soft breaks

IceSentry force-pushed the migration-guide-0.10 branch from 5705568 to 21f380a Compare February 18, 2023 20:21

IceSentry added 8 commits February 18, 2023 16:05

remove tags

2c05320

regenerate

f37dd4e

manual clean up

e6c9134

re add tags

c7f1236

remove unnecessary part

10c9ed4

soft breaks

3eaa8c6

icosphere

174a418

generate

51474f9

bors bot added a commit that referenced this pull request Feb 20, 2023

Try #530:

637bce5

alice-i-cecile added A-Book C-Content labels Feb 21, 2023

afonsolage reviewed Feb 22, 2023

View reviewed changes

rparrett reviewed Feb 22, 2023

View reviewed changes

content/learn/book/migration-guides/0.9-0.10/_index.md Outdated Show resolved Hide resolved

nicopap reviewed Feb 24, 2023

View reviewed changes

content/learn/book/migration-guides/0.9-0.10/_index.md Outdated Show resolved Hide resolved

nicopap reviewed Feb 24, 2023

View reviewed changes

IceSentry and others added 4 commits March 3, 2023 00:55

generate

4349dc1

Apply suggestions from code review

7a9b831

Co-authored-by: Edgar Geier <geieredgar@gmail.com> Co-authored-by: Afonso Lage <lage.afonso@gmail.com> Co-authored-by: TimJentzsch <TimJentzsch.github.com@timjen.net> Co-authored-by: Rob Parrett <robparrett@gmail.com>

clean up

98ca8a8

Apply suggestions from code review

0835ead

Co-authored-by: ickshonpe <david.curthoys@googlemail.com> Co-authored-by: Rob Parrett <robparrett@gmail.com>

IceSentry added 3 commits March 3, 2023 01:34

Clean up

ffd1f72

more clean up

ebbddc6

css

86c4210

LiamGallagher737 reviewed Mar 3, 2023

View reviewed changes

content/learn/book/migration-guides/0.9-0.10/_index.md Outdated Show resolved Hide resolved

Update content/learn/book/migration-guides/0.9-0.10/_index.md

540e62b

Co-authored-by: Liam Gallagher <ljpgallagher@xtra.co.nz>

JoJoJet reviewed Mar 4, 2023

View reviewed changes

content/learn/book/migration-guides/0.9-0.10/_index.md Outdated Show resolved Hide resolved

alice-i-cecile reviewed Mar 4, 2023

View reviewed changes

Update content/learn/book/migration-guides/0.9-0.10/_index.md

f603009

Co-authored-by: JoJoJet <21144246+JoJoJet@users.noreply.github.com>

fixed timestep

d48a0e7

alice-i-cecile reviewed Mar 4, 2023

View reviewed changes

content/learn/book/migration-guides/0.9-0.10/_index.md Outdated Show resolved Hide resolved

IceSentry and others added 2 commits March 4, 2023 16:19

Update content/learn/book/migration-guides/0.9-0.10/_index.md

3364610

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>

fix

68a703e

coreh reviewed Mar 4, 2023

View reviewed changes

content/learn/book/migration-guides/0.9-0.10/_index.md Show resolved Hide resolved

cart and others added 3 commits March 4, 2023 15:48

Update content/learn/book/migration-guides/0.9-0.10/_index.md

628c3d1

Co-authored-by: Marco Buono <thecoreh@gmail.com>

bump highly relevant sections to the top

6b48f6f

Clean up Schedule v3 migration guide, reorder, and remove irrelevant …

8d8408d

…lines

cart approved these changes Mar 4, 2023

View reviewed changes

bors bot changed the title ~~Migration guide 0.9-0.10~~ [Merged by Bors] - Migration guide 0.9-0.10 Mar 5, 2023

bors bot closed this Mar 5, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Merged by Bors] - Migration guide 0.9-0.10 #530

[Merged by Bors] - Migration guide 0.9-0.10 #530

IceSentry commented Feb 4, 2023 •

edited

Loading

james7132 left a comment

james7132 Feb 5, 2023

IceSentry Feb 5, 2023

TimJentzsch commented Feb 8, 2023

IceSentry commented Feb 20, 2023

bors bot commented Feb 20, 2023

afonsolage left a comment

nicopap left a comment •

edited

Loading

james7132 commented Feb 27, 2023

IceSentry commented Mar 3, 2023

alice-i-cecile Mar 4, 2023

IceSentry Mar 4, 2023

alice-i-cecile commented Mar 4, 2023 •

edited

Loading

IceSentry commented Mar 4, 2023 •

edited

Loading

alice-i-cecile commented Mar 4, 2023

cart left a comment

cart commented Mar 4, 2023

bors bot commented Mar 5, 2023


		### [Remove `TextError::ExceedMaxTextAtlases(usize)` variant](https://github.com/bevyengine/bevy/pull/6796)

		<div class="migration-guide-area-tags">

[Merged by Bors] - Migration guide 0.9-0.10 #530

[Merged by Bors] - Migration guide 0.9-0.10 #530

Conversation

IceSentry commented Feb 4, 2023 • edited Loading

james7132 left a comment

Choose a reason for hiding this comment

james7132 Feb 5, 2023

Choose a reason for hiding this comment

IceSentry Feb 5, 2023

Choose a reason for hiding this comment

TimJentzsch commented Feb 8, 2023

IceSentry commented Feb 20, 2023

bors bot commented Feb 20, 2023

try

afonsolage left a comment

Choose a reason for hiding this comment

nicopap left a comment • edited Loading

Choose a reason for hiding this comment

james7132 commented Feb 27, 2023

IceSentry commented Mar 3, 2023

alice-i-cecile Mar 4, 2023

Choose a reason for hiding this comment

IceSentry Mar 4, 2023

Choose a reason for hiding this comment

alice-i-cecile commented Mar 4, 2023 • edited Loading

Multiple fixed timesteps

IceSentry commented Mar 4, 2023 • edited Loading

alice-i-cecile commented Mar 4, 2023

cart left a comment

Choose a reason for hiding this comment

cart commented Mar 4, 2023

bors bot commented Mar 5, 2023

IceSentry commented Feb 4, 2023 •

edited

Loading

nicopap left a comment •

edited

Loading

alice-i-cecile commented Mar 4, 2023 •

edited

Loading

IceSentry commented Mar 4, 2023 •

edited

Loading