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 yaml linting check in CI #183

Closed
wants to merge 3 commits into from
Closed

Conversation

meili-bot
Copy link
Contributor

This PR is auto-generated.

To avoid mistakes in the yaml files, for example, duplicated keys or wrong indentation, we decided to add a lint check on yaml files.

Additional to the .yamllint files added in this pr, the following must be added as well:

  • Linting check in CI:
    Example in `tests.yml create a new job:
    yaml-lint:
      name: Yaml linting check
      runs-on: ubuntu-latest
      steps:
        - uses: actions/checkout@v3
        - name: Yaml lint check
          uses: ibiqlik/action-yamllint@v3
          with:
            config_file: .yamllint.yml
  • Inside .yamllint, you might want to ignore some folders. For example node_modules in JS repos
    Example in .yamllint:
    ignore: |
      node_modules

Since yamllint is a python package, we cannot add a local check unless you download .yamllint.
In which case, you can check if the yaml files are correctly linted by running the following command: yamllint .

Additionally, you can use the VSCode extension YAML by redhat which automatically highlights errors.

To help users be aware of this, we recommend adding this to your contributing guide:

To check if your `yaml` files are correctly formatted, you need to [install yamllint](https://yamllint.readthedocs.io/en/stable/quickstart.html#installing-yamllint) and then run `yamllint .`

TODO

  • Add the directories or files to ignore in .yamllint
  • Add information in the contributing guide on this new check.

@meili-bot meili-bot added the skip-changelog The PR will not appear in the release changelogs label Jun 14, 2023
@alallema
Copy link
Contributor

alallema commented Aug 2, 2023

This PR was mainly created to avoid errors in sample codes, but this repo doesn't have any, so I'm closing it.

@alallema alallema closed this Aug 2, 2023
@brunoocasali brunoocasali deleted the meili-bot/add-yamllint branch October 24, 2023 19:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog The PR will not appear in the release changelogs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants