Use correct syntax for empty YAML sequence #123
Merged
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 project uses a standardized target line length of 120 for YAML files. In some cases it is not feasible to meet that target, but other lines were unnecessarily long.
Unlike the other inputs (`platforms`, `sketch-paths`) that take a "sequence" (AKA array, list) type YAML document as input, because a sketch may have no library dependencies it is valid and common to pass an empty sequence via the `libraries` input. Due to the need to maintain backwards compatibility with the original short-sighted design of the action API, which didn't consider the action being used with any project type other than libraries, it is necessary for the user to do this in their workflow rather than simply omitting the `libraries` input. Previously the documentation and tests used "-" for this purpose. That is supported, but is not an empty sequence, but rather a sequence consisting of a single null element. The only way to specify an empty sequence in YAML is `[]`.
per1234
added
type: imperfection
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## main #123 +/- ##
=======================================
Coverage 99.81% 99.81%
=======================================
Files 2 2
Lines 1610 1610
=======================================
Hits 1607 1607
Misses 3 3
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
Unlike the other inputs (
platforms,sketch-paths) that use a "sequence" (AKA array, list) type YAML document, because a sketch may have no library dependencies it is valid and common to pass an empty sequence via thelibrariesinput.Due to the need to maintain backwards compatibility with the original short-sighted design of the action API, which didn't consider the action being used with any project type other than libraries, it is necessary for the user to do this in their workflow rather than simply omitting the
librariesinput.Previously the documentation and tests used
"-"for this purpose. That is supported, but is not an empty sequence, but rather a sequence consisting of a single null element. The only way to specify an empty sequence in YAML is[].