This repository has been archived by the owner on Oct 22, 2021. It is now read-only.
Add yaml linting #161
Merged
Add yaml linting #161
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Linting the helm templates fail, eg: We can't use |
viccuad
added
the
Status: Blocked
|
#165 Should unblock this PR. |
fargozhu
added
Type: CI
viccuad
force-pushed
the
viccuad/add-yaml-linting
branch
from
be694cc
to
9de4f1d
Compare
|
Rebased on top of master to include #165. |
f0rmiga
suggested changes
Nov 19, 2019
mook-as
suggested changes
Nov 19, 2019
viccuad
force-pushed
the
viccuad/add-yaml-linting
branch
from
9de4f1d
to
7041b3f
Compare
|
Many thanks for the review :). Also, I'm quite embarrassed by the simple mistakes I did. I have fixed the typos and force-pushed with new changes, which I think it's gonna be cleaner:
|
Python 3 compatibility is yet unreleased, pin commit for now.
Pip3 install yamllint by performing a 2-step process, first declare a pip repostory with pip_repositories(), and then install the module and dependencies with pip_install(). Pip needs to be executed at WORKSPACE-evaluation time. Call yamllint by wrapping it on `dev/linters/run_yamllint.py`, using py_binary() bazel function.
Use relaxed rules for only errors, don't check ./deploy/helm/kubecf/* as it contains helm templates, but check ./deploy/helm/kubecf/values.* .
viccuad
force-pushed
the
viccuad/add-yaml-linting
branch
from
7041b3f
to
3f92af2
Compare
|
Rebased on top of master to fix conflicts. |
f0rmiga
approved these changes
Nov 26, 2019
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds yaml linting to the dev/ scripts and gitlab, which lints for yaml files, excluding
deploy/helm/kubecf/*, as those are helm templates that should be better linted withhelm lint.To achieve it, it adds a bazel target
//dev/linters:yamllintto install the yamllint python module, and a python wrapper to call it. I haven't found any other way in Bazel to pull a python module and then call it.It provides the script
dev/linters/yamllint.shthat calls the python wrapper. And it updates.gitlab-ci.yamlto call this last script.Bazel's pip_install() doesn't install pip, so this PR needs f0rmiga/bazel-docker-image#3.
Motivation and Context
How Has This Been Tested?
I have tested it locally by running
dev/linters/yamllint.sh.I have tested it against gitlab-ci by editing the
.gitlab-ci.yamltozypper in pip, and runninggitlab-runner exec docker lint.Screenshots (if appropriate):
Types of changes
Checklist: