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

Make module a no-op by default, and add check for no-op #430

Merged
merged 3 commits into from
Oct 21, 2024

Conversation

samueldr
Copy link
Member

@samueldr samueldr commented Oct 21, 2024

Enabling the steamos config with enabling steam is the best semantics we have around wanting to use the steamos config... and conversely, not using steam and using the steamos semantics would be weird and I think it's fair for it to be opt-in.

The ./support/nix-tests/check-no-ops.nix script can be used to check that eval of the module is a no-op.

A check has been added for that purpose.


Example check failing:

(Against this PR, with the modules/steamos no-op commit reverted)

Same check now working:

This script can be used to check that the current repository state is a
no-op.
This is the best semantics we have around wanting to use the steamos
config... and conversely, not using steam and using the steamos
semantics would be *weird* and I think it's fair for it to be opt-in.
@samueldr samueldr force-pushed the fix/no-op-oversight branch from bbc4688 to 0c09446 Compare October 21, 2024 01:30
@samueldr samueldr requested a review from K900 October 21, 2024 01:33
@samueldr samueldr marked this pull request as ready for review October 21, 2024 01:33
Copy link
Contributor

@K900 K900 left a comment

Choose a reason for hiding this comment

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

LGTM, the thing that worries me a little bit is gating it behind steam.enable even though most of those aren't necessarily Steam specific, but I also don't know a better namespace to put them in...

@samueldr
Copy link
Member Author

I had the same sentiment, but again... importing this repo and having to enable an option when not using Steam, and yet wanting the SteamOS semantics seems to me like it's a fair trade-off.

The other situation around the SteamOS semantics (not wanting the SteamOS semantics while wanting the Steam experience) is already requiring an option to be set. So nothing changes here.

@samueldr samueldr merged commit 82bdda1 into development Oct 21, 2024
70 checks passed
@samueldr samueldr deleted the fix/no-op-oversight branch October 21, 2024 06:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants