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

Add linting of YAML files #896

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Conversation

wwarriner
Copy link
Contributor

@wwarriner wwarriner commented Jan 29, 2025

Pull Request

Overview

Adds linting of YAML files to pre-commit hooks and to CI check step. Sorry, there isn't a good method to get real-time linting in VSCode yet.

This should help reduce issues with unintentional changes to YAML files.

Proposed Changes

  • Adds yamllint to build environment.
  • Adds yamllint to pre-commit hooks.
  • Adds yamllint to CI check step.
  • Adds .yamllint.yaml config file.
  • Updates YAML files to comply with .yamllint.yaml configuration file.

Related Issues

Fixes #747

@wwarriner wwarriner added the pr: review PR is ready for review label Feb 4, 2025
@bdu-birhanu
Copy link
Contributor

Everything looks great on my end!
I tested it on my local system, and it works well, except for an entry line in the pre-commit-config.yaml under hooks, as noted below.

@bdu-birhanu bdu-birhanu added pr: needs changes Review complete, needs changes and removed pr: review PR is ready for review labels Feb 18, 2025
@wwarriner wwarriner added pr: review PR is ready for review and removed pr: needs changes Review complete, needs changes labels Feb 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr: review PR is ready for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add yaml linting to CI/CD to avoid issues with the nav section.
2 participants