Neuter min space requirement for inline comments #1821
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
Update our yamllint config defaults to disable the requirement of adding two spaces before each inline comments. This does not affect users that already set a different value in their yamllint config files. This will improve the compatibility with various code formatters, as mentioned in ansible#1820
ssbarnea
requested review from
relrod,
ganeshrn and
priyamsahoo
and removed request for
a team
greg-hellings
approved these changes
Jan 21, 2022
webknjaz
reviewed
Jan 21, 2022
cognifloyd
approved these changes
Jan 22, 2022
webknjaz
approved these changes
Jan 22, 2022
tadeboro
suggested changes
Jan 23, 2022
There was a problem hiding this comment.
Does this change mean that previously "green" YAML files will now become "red"? If yes, then I am -1 on this change during the 5.x.y series of releases. Breaking people's CI/CD setups is not something we should do lightly.
And I know introducing new rules can also "break" the CI/CD, but those situations are different since in most cases they indicate that something can be improved. Changing comment formatting brings no direct benefit to linter users.
|
I did not see any breakage reported by eco job but I do realise that someone could be surprised by the new setup. Maybe we can do this in two steps, first disabling that check and delaying the new preference for a major version change. |
ssbarnea
changed the title
ssbarnea
changed the title
tadeboro
approved these changes
Feb 2, 2022
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.
Update our yamllint config defaults to disable the requirement of adding two spaces before each inline comments. This does not affect users that already set a different value in their yamllint config files.
This change will not produce extra errors after is applied, it will only reduce the number of errors reported in general as
foo: bar # that is cool!will no longer complain about missing an additional space, using one or two will be fine.The expected behavior is that ansible-lint will no longer report problems like:
This will improve the compatibility with various code formatters, as mentioned in #1820