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

impl ExclusiveSystemParam for SystemName #11163

Merged
merged 1 commit into from
Jan 1, 2024

Conversation

stepancheg
Copy link
Contributor

@stepancheg stepancheg commented Dec 31, 2023

Objective

SystemName might be useful in systems which accept &mut World.

Solution

  • impl ExclusiveSystemParam for SystemName
  • move SystemName into a separate file, because it no longer belongs to a file which defines SystemParam
  • add a test for new impl, and for existing impl

Changelog

  • impl ExclusiveSystemParam for SystemName

@alice-i-cecile alice-i-cecile added A-ECS Entities, components, systems, and events C-Usability A targeted quality-of-life change that makes Bevy easier to use labels Dec 31, 2023
Copy link
Member

@alice-i-cecile alice-i-cecile left a comment

Choose a reason for hiding this comment

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

Good. I'm particularly glad that we're slowly splitting up that huge file.

Copy link
Contributor

@hymm hymm left a comment

Choose a reason for hiding this comment

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

This is a breaking change if you were importing SystemName from system_param::SyatemName

@hymm hymm added M-Needs-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it labels Dec 31, 2023
Copy link
Contributor

It looks like your PR is a breaking change, but you didn't provide a migration guide.

Could you add some context on what users should update when this change get released in a new version of Bevy?
It will be used to help writing the migration guide for the version. Putting it after a ## Migration Guide will help it get automatically picked up by our tooling.

@stepancheg
Copy link
Contributor Author

@hymm it is not because SystemName is exported in mod system.

image

@hymm hymm removed the M-Needs-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide label Dec 31, 2023
@stepancheg
Copy link
Contributor Author

I guess somewhere out there there are tools to detect mechanical API changes automatically and correctly.

@alice-i-cecile
Copy link
Member

Yeah, the tool in question would be https://crates.io/crates/cargo-semver-checks. Probably worth adding to our CI pipeline down the line.

@alice-i-cecile alice-i-cecile added this pull request to the merge queue Jan 1, 2024
Merged via the queue into bevyengine:main with commit 6bc2686 Jan 1, 2024
27 checks passed
@stepancheg stepancheg deleted the system-name-exclusive branch January 1, 2024 17:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-ECS Entities, components, systems, and events C-Usability A targeted quality-of-life change that makes Bevy easier to use 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.

3 participants