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

checks: fix some yamllint and markdownlint errors #3656

Merged
merged 1 commit into from
Apr 27, 2024

Conversation

nilason
Copy link
Contributor

@nilason nilason commented Apr 23, 2024

Fixes some pre-commit yamllint and markdownlint errors, which have sneaked in again.

@nilason nilason added this to the 8.4.0 milestone Apr 23, 2024
@nilason nilason self-assigned this Apr 23, 2024
@nilason nilason requested a review from echoix April 23, 2024 18:10
@github-actions github-actions bot added CI Continuous integration docs labels Apr 23, 2024
@echoix
Copy link
Member

echoix commented Apr 23, 2024

I find the indentation weird on the labeler file. It seems a bit more than expected.

Would you think it would be better to match it with upgrading the tool version in the pre commit config? I remember that at least one of them was broken and would never work. #3318 Ah, it was flake8.

If there was a config file, .yamllint.yml, we could have the same config in precommit, other ide intregrations, but more specifically, the super-linter could be configured to have the same settings, and enforce it there.

The default config file used in Megalinter is the minimum required so that yamllint and prettier don't conflict each other https://github.com/oxsecurity/megalinter/blob/03986e6993ccf699a22451118520680b438e7d2a/TEMPLATES/.yamllint.yml
Super-linter's default config file is https://github.com/super-linter/super-linter/blob/53361158a1cdd3b7660986e00d8635147970e842/TEMPLATES/.yaml-lint.yml

The current config used for pre-commit is

- repo: https://github.com/adrienverge/yamllint.git
rev: v1.29.0
hooks:
- id: yamllint
args: [--format, parsable, --strict, -d,
'{extends: default, rules: {truthy: disable,
line-length: {max: 120, allow-non-breakable-words: true},
comments: {min-spaces-from-content: 1}}}']

Also, maybe a basic .editorconfig could be helpful for setting some of the formatting that we use.

Copy link
Member

@echoix echoix left a comment

Choose a reason for hiding this comment

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

There's nothing wrong with these changes, so I'm not blocking it for weeks, but as my comment, I think having a solution that prevents this from happening would be even better.

@wenzeslaus wenzeslaus merged commit 01a06ec into OSGeo:main Apr 27, 2024
27 checks passed
@nilason nilason deleted the fix_pre-commit_errors branch May 15, 2024 09:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous integration docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants