Add human readable yaml ordering #1326
Merged
Conversation
This file contains 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
Signed-off-by: Elliot Gunton <elliotgunton@gmail.com>
* Replace alphabetical ordering in example YAMLs Signed-off-by: Elliot Gunton <elliotgunton@gmail.com>
Remaining examples will be added in a separate PR. Signed-off-by: Elliot Gunton <elliotgunton@gmail.com>
elliotgunton
added
type:enhancement
Signed-off-by: Elliot Gunton <elliotgunton@gmail.com>
Signed-off-by: Elliot Gunton <elliotgunton@gmail.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1326 +/- ##
=====================================
Coverage 86.4% 86.4%
=====================================
Files 60 60
Lines 4099 4118 +19
Branches 651 657 +6
=====================================
+ Hits 3543 3562 +19
Misses 388 388
Partials 168 168 ☔ View full report in Codecov by Sentry. |
alicederyn
requested changes
Mar 3, 2025
jaseemabid
reviewed
Mar 3, 2025
Signed-off-by: Elliot Gunton <elliotgunton@gmail.com>
elliotgunton
force-pushed
the
add-human-readable-yaml-ordering
branch
from
1f83db1 to
ef93806
Compare
elliotgunton
added a commit
that referenced
this pull request
Mar 3, 2025
* If the upstream examples are changed while working on a feature, it can be frustrating to regenerate YAML files as they cannot match without manually editing the Python versions, which mixes up intentions in the PR. * For that reason, use separate make targets for regenerating the Hera-generated YAML files (`regenerate-upstream-test-data`) and fetching the actual upstream YAML files - `fetch-upstream-examples`. * Add a check (when `REPORT_DIFFS` env var is set) to ensure that the local copy of the upstream YAML matches for `regenerate-upstream-test-data`, with a test fail message to tell user to fetch the new YAML with the `fetch-upstream-examples` target. * Update the `regenerate-test-data` target to only regenerate non-upstream examples. With this change the new developer workflow will be: * If making changes to Hera-specific examples (e.g. runner examples), use `make regenerate-test-data` * If making changes that affect all examples (e.g. YAML key ordering #1326) which should rarely happen, use both: `make regenerate-test-data regenerate-upstream-test-data` * See if there are changes to upstream example YAMLs that have been recreated in Hera by running `REPORT_DIFFS make regenerate-upstream-test-data` (TODO: add an automated way to notify us of changes) * If there are new upstream examples or they have changed, run `make fetch-upstream-examples` to update the `.upstream.yaml` files, then work on the respective Python files to update the Hera workflow, and then regenerate the matching `.yaml` files using `make regenerate-upstream-test-data` --------- Signed-off-by: Elliot Gunton <elliotgunton@gmail.com>
Signed-off-by: Elliot Gunton <elliotgunton@gmail.com>
Signed-off-by: Elliot Gunton <elliotgunton@gmail.com>
alicederyn
approved these changes
Mar 3, 2025
|
Thank you for this 👍 |
elliotgunton
added a commit
that referenced
this pull request
Mar 4, 2025
WF templates can have list of lists, for example steps. This PR makes sure those are sorted as well. Follow up to #1326 --------- Signed-off-by: Jaseem Abid <me@jabid.in> Signed-off-by: Elliot Gunton <elliotgunton@gmail.com> Co-authored-by: Elliot Gunton <elliotgunton@gmail.com>
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
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.
Pull Request Checklist
Description of PR
Based on YAML being a bunch of nested dictionaries, we can order the nested dictionaries by the
namekey always-first, then plain data types, then lists, and then dicts, which should go some way towards making Hera-outputted YAMLs much friendlier to DevOps and YAML-first collaborators. As YAML makes no guarantee on dictionary ordering, this change is entirely cosmetic to improve human readability (IMO it really does make the YAML better to read).Commits are arranged to show changes/fixes per file, then the final commit adds all non-upstream YAMLs (now with nice ordering!)