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 config for yamllint; Apply yamllint to all YAML files. #194

Merged
merged 2 commits into from
Dec 24, 2023

Conversation

kirkrodrigues
Copy link
Member

@kirkrodrigues kirkrodrigues commented Dec 24, 2023

Description

yamllint is a package for linting YAML files with options like enforcing all strings must be quoted. This PR adds a yamllint config file and applies it to all YAML files in the repo.

To run yamllint:

python3 -m venv yamllint-venv
. yamllint-venv/bin/activate
pip3 install --upgrade yamllint
yamllint .

The only files it should complain about are the ones from yamllint-venv.

We will add a workflow to run it in a future PR.

Copy link
Member

@LinZhihao-723 LinZhihao-723 left a comment

Choose a reason for hiding this comment

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

lgtm

@kirkrodrigues kirkrodrigues merged commit 538c41b into y-scope:main Dec 24, 2023
6 checks passed
@kirkrodrigues kirkrodrigues deleted the yaml-lint branch December 24, 2023 21:08
@kirkrodrigues kirkrodrigues changed the title Add config for yamllint and apply yamllint to all YAML files. Add config for yamllint; Apply yamllint to all YAML files. Dec 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants