-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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
[ci] fix errors about comments indentation in yaml files (Part 3) #6794
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should do something slightly different for this one.
.vsts-ci.yml
Outdated
- job: Maintenance | ||
########################################### | ||
######################################### |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a case where I disagree with yamllint
. These aren't normal comments with text conveying information... they're more like ASCII art or markup trying to visually distinguish sections.
Given that, I don't like this mis-alignment:

I have found these really helpful when visually scanning this file.
Would you consider this alternative form that the linter should still be happy with?
jobs:
#############
# Maintenance #
#############
- job: Maintenance
pool: mariner-20240410-0
Similar to what we have for the R CI?
LightGBM/.github/workflows/r_package.yml
Lines 58 to 60 in e90477b
################ | |
# CMake builds # | |
################ |
LightGBM/.github/workflows/r_package.yml
Lines 115 to 117 in e90477b
############### | |
# CRAN builds # | |
############### |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great idea! Will follow your suggestion.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done in 26c632a.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the way this looks, thanks!
Third PR in series of PRs for linting yaml files.
Continuation of #6789.
See #6758 for background and future PRs' content required to fix all errors with the proposed config.