twoliter: sort bootconfig keys across all snippets #596
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The property we would like is that, given the same input, `rpm2img` and `prairiedog` should produce the same output. On a running system, `prairiedog` handles reading bootconfig inputs from the settings API, by way of its TOML config file, which causes any existing ordering to be lost. However, `prairiedog` can sort its output; if `rpm2img` also sorts its output, then we can achieve the desired outcome. Reject any complex bootconfig files that would be broken by sorting, then sort output lines so they appear in a consistent order. Signed-off-by: Ben Cressey <[email protected]>
jpculp
approved these changes
Nov 11, 2025
cbgbt
approved these changes
Nov 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue number:
Related: bottlerocket-os/bottlerocket#4680
Description of changes:
The property we would like is that, given the same input,
rpm2imgandprairiedogshould produce the same bootconfig output.On a running system,
prairiedoghandles reading bootconfig inputs from the settings API, by way of its TOML config file, which causes any existing ordering to be lost. However,prairiedogcan sort its output; ifrpm2imgalso sorts its output, then we can achieve the desired outcome.Reject any complex bootconfig files that would be broken by sorting, then sort output lines so they appear in a consistent order.
Testing done:
See bottlerocket-os/bottlerocket-core-kit#735 for the
prairiedogwhich has the prairiedog side of this change.Terms of contribution:
By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license.