Skip to content

0.18: Remove references to ReaderRequiredFeatures#22430

Merged
alice-i-cecile merged 4 commits intobevyengine:release-0.18.0from
greeble-dev:reader-required-features-removal
Jan 8, 2026
Merged

0.18: Remove references to ReaderRequiredFeatures#22430
alice-i-cecile merged 4 commits intobevyengine:release-0.18.0from
greeble-dev:reader-required-features-removal

Conversation

@greeble-dev
Copy link
Contributor

ReaderRequiredFeatures was added by #22104 and removed by #22182, but some references snuck into the 0.18 branch. This was causing a compile error if the trace feature was enabled, and some release content was misleading.

@greeble-dev greeble-dev requested a review from andriyDev January 8, 2026 14:50
@greeble-dev greeble-dev added C-Bug An unexpected or incorrect behavior C-Docs An addition or correction to our documentation A-Assets Load files from disk to use for things like images, models, and sounds P-Compile-Failure A failure to compile Bevy apps S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Jan 8, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Jan 8, 2026

Your PR caused a change in the graphical output of an example or rendering test. This might be intentional, but it could also mean that something broke!
You can review it at https://pixel-eagle.com/project/B04F67C0-C054-4A6F-92EC-F599FEC2FD1D?filter=PR-22430

If it's expected, please add the M-Deliberate-Rendering-Change label.

If this change seems unrelated to your PR, you can consider updating your PR to target the latest main branch, either by rebasing or merging main into it.

@greeble-dev
Copy link
Contributor Author

I think the pixel eagle warning might be a red herring due to this PR targeting the 0.18 branch?

@kfc35
Copy link
Contributor

kfc35 commented Jan 8, 2026

I think the pixel eagle warning might be a red herring due to this PR targeting the 0.18 branch?

Yep there’s an issue to address this #22368

@janhohenheim janhohenheim added this to the 0.18 milestone Jan 8, 2026
which may not support seeking backwards). However, it also meant that we could no longer use seeking
fully where it was available.

To resolve this issue, we now allow `AssetLoader`s to provide a `ReaderRequiredFeatures` to the
Copy link
Contributor

@andriyDev andriyDev Jan 8, 2026

Choose a reason for hiding this comment

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

This release notes is still relevant, but we need to rewrite this to remove references to ReaderRequiredFeatures and point people to seekable.

If you don't get to it before I do, I'll PR your branch.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll defer to you on the release note.

Maybe worth noting that Alice had flagged up the original release note as needing more context (#22421)

  • optional_asset_reader_seek.md
    • cut or add more context on what this enables

Copy link
Member

Choose a reason for hiding this comment

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

I think that seekable assets are probably worth covering, but we need to do a better job explaining why this is impactful.

Copy link
Contributor

Choose a reason for hiding this comment

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

In that case, can we bring back this file and then just add a TODO on it to fix it to reference seekable? This can be expanded on later, I just don't want to delete this and forget about it, or forget to make it match the published lib.

@greeble-dev
Copy link
Contributor Author

Following #22430 (comment), I've restored the release note but added a TODO.

Since this PR fixes a CI failure, I'm assuming it's best to push it through even if the release notes aren't finished.

@alice-i-cecile alice-i-cecile merged commit 900f508 into bevyengine:release-0.18.0 Jan 8, 2026
24 of 25 checks passed
@alice-i-cecile alice-i-cecile 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 Jan 8, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Jan 8, 2026

Your PR caused a change in the graphical output of an example or rendering test. This might be intentional, but it could also mean that something broke!
You can review it at https://pixel-eagle.com/project/B04F67C0-C054-4A6F-92EC-F599FEC2FD1D?filter=PR-22430

If it's expected, please add the M-Deliberate-Rendering-Change label.

If this change seems unrelated to your PR, you can consider updating your PR to target the latest main branch, either by rebasing or merging main into it.

@greeble-dev
Copy link
Contributor Author

Ack, looks like this breaks CI due to markdown lint.

 /github/workspace/release-content/release-notes/optional_asset_reader_seek.md:7:64 MD034/no-bare-urls Bare URL used [Context: "https://github.com/bevyengine/..."]

I'm not sure how to move forward. Let me know if I should fix in this branch or start a new PR.

@andriyDev
Copy link
Contributor

@greeble-dev this PR is merged, so I think start a new branch on main? Happy to approve.

alice-i-cecile pushed a commit that referenced this pull request Jan 8, 2026
…te (#22436)

Fix markdown lint that slipped into #22430.

I have not tested this locally - I'm relying on CI to verify.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-Assets Load files from disk to use for things like images, models, and sounds C-Bug An unexpected or incorrect behavior C-Docs An addition or correction to our documentation P-Compile-Failure A failure to compile Bevy apps 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