Skip to content
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

Merged
merged 5 commits into from
Jan 26, 2025

Conversation

StrikerRUS
Copy link
Collaborator

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.

Copy link
Collaborator

@jameslamb jameslamb left a 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
###########################################
#########################################
Copy link
Collaborator

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:

Screen Shot 2025-01-20 at 4 13 53 PM

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?

################
# CMake builds #
################

###############
# CRAN builds #
###############

Copy link
Collaborator Author

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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 26c632a.

@StrikerRUS StrikerRUS requested a review from jameslamb January 26, 2025 16:36
Copy link
Collaborator

@jameslamb jameslamb left a 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!

@jameslamb jameslamb merged commit 335d168 into master Jan 26, 2025
48 checks passed
@jameslamb jameslamb deleted the ci/yamllint-3 branch January 26, 2025 19:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants