Skip to content

Adds migration instructions for old zstd feature.#21161

Merged
alice-i-cecile merged 3 commits intobevyengine:mainfrom
noahsabaj:fix-zstd-migration-guide
Sep 22, 2025
Merged

Adds migration instructions for old zstd feature.#21161
alice-i-cecile merged 3 commits intobevyengine:mainfrom
noahsabaj:fix-zstd-migration-guide

Conversation

@noahsabaj
Copy link
Copy Markdown
Contributor

@noahsabaj noahsabaj commented Sep 22, 2025

Objective

Fixes #21089

The migration guide for the zstd feature changes didn't explain how to migrate from the old zstd feature to the new split features.

Solution

Added migration instructions showing that the old zstd feature should be replaced with either zstd_rust (safe default) or zstd_c (faster but unsafe).

Testing

Link to the issue: #21089

… now explains how to migrate from the old 'zstd' feature to either 'zstd_rust' or 'zstd_c'. Fixes bevyengine#21089.
@janhohenheim
Copy link
Copy Markdown
Member

Thanks a bunch! Just one note to make it easier for people who don't care about the C backend and just want their Bevy apps to work the same as before :)

@alice-i-cecile alice-i-cecile added 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 labels Sep 22, 2025
@alice-i-cecile
Copy link
Copy Markdown
Member

Thanks for tackling this!

@james7132 james7132 added this to the 0.17 milestone Sep 22, 2025
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Sep 22, 2025
Merged via the queue into bevyengine:main with commit e4f93a2 Sep 22, 2025
33 checks passed
@noahsabaj noahsabaj deleted the fix-zstd-migration-guide branch September 22, 2025 18:19
mockersf pushed a commit that referenced this pull request Sep 22, 2025
# Objective

Fixes #21089 

The migration guide for the `zstd` feature changes didn't explain how to
migrate from the old `zstd` feature to the new split features.

## Solution

Added migration instructions showing that the old `zstd` feature should
be replaced with either `zstd_rust` (safe default) or `zstd_c` (faster
but unsafe).

## Testing

- Documentation change only, no code to test
- Verified the feature change in git history (PR #19793)

##
Link to the issue:
[https://github.com/bevyengine/bevy/issues/21089](https://github.com/bevyengine/bevy/issues/21089)

---------

Co-authored-by: Alice Cecile <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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.

Missing migration: zstd changes don't mention how to migrate the old zstd feature for the same behavior

4 participants