Cleanup YAML Linting and Enable Rules (#2301)

* Fix yaml linting issues

* Enable yamllint rules

* Replace comment

* Address linting and set line-length longer

Co-authored-by: Lukas Gravley <admiralawkbar@github.com>
This commit is contained in:
Brett Logan 2022-01-06 10:59:15 -05:00 committed by GitHub
parent 42981a4a7a
commit f0e69a5a7d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
19 changed files with 46 additions and 38 deletions

View file

@ -1,3 +1,4 @@
---
AWSTemplateFormatVersion: "2010-09-09"
Description: A sample template
Resources:

View file

@ -1,3 +1,4 @@
---
AWSTemplateFormatVersion: "2010-09-09"
Description: A sample template
Resources:

View file

@ -1,3 +1,4 @@
---
name: Github Actions Bad
on:
push:

View file

@ -1,3 +1,4 @@
---
name: GitHub Actions Good
on:
push:

View file

@ -1 +1,2 @@
---
openapi: '3.0.0'

View file

@ -1,3 +1,4 @@
---
openapi: 3.0.0
info:
title: Example
@ -8,6 +9,6 @@ info:
description: Test for super-linter
servers:
- url: 'http://localhost:3000'
paths: {}
paths: { }
tags:
- name: example

View file

@ -1,3 +1,4 @@
---
apiVersion: tekton.dev/v1beta1
kind: Task
metadata:
@ -30,4 +31,4 @@ spec:
mountPath: /var/run/docker.sock
volumes:
- name: sample-example-volume
emptyDir: {}
emptyDir: { }

View file

@ -1,3 +1,4 @@
---
apiVersion: tekton.dev/v1beta1
kind: Task
metadata:
@ -30,4 +31,4 @@ spec:
mountPath: /var/run/docker.sock
volumes:
- name: example-volume
emptyDir: {}
emptyDir: { }

View file

@ -8,7 +8,7 @@
#############################
# Exclude paths from linter #
#############################
#exclude_paths:
# exclude_paths:
########################
# Make output parsable #
@ -23,23 +23,23 @@ quiet: true
#####################
# Path to rules dir #
#####################
#rulesdir:
# rulesdir:
################
# Tags to skip #
################
skip_list:
- 'empty-string-compare' # Allow compare to empty string
- '204' # Allow string length greater than 160 chars
- 'no-changed-when' # False positives for running command shells
- 'command-instead-of-module' # Allow git commands for push, add, etc...
- 'command-instead-of-shell' # Allow use of shell when you want
- 'no-handler' # Allow step to run like handler
- 'empty-string-compare' # Allow compare to empty string
- '204' # Allow string length greater than 160 chars
- 'no-changed-when' # False positives for running command shells
- 'command-instead-of-module' # Allow git commands for push, add, etc...
- 'command-instead-of-shell' # Allow use of shell when you want
- 'no-handler' # Allow step to run like handler
##################
# Tags to follow #
##################
#tags:
# tags:
#############
# Use rules #

View file

@ -37,7 +37,8 @@ plugins:
#########
# Rules #
#########
# rules:
rules: { }
##############################
# Overrides for JSON parsing #

View file

@ -5,8 +5,9 @@
#########################
#########################
#configure golangci-lint
#See https://github.com/golangci/golangci-lint/blob/master/.golangci.example.yml
# configure golangci-lint
# https://github.com/golangci/golangci-lint/blob/master/.golangci.example.yml
issues:
exclude-rules:
- path: _test\.go
@ -26,8 +27,7 @@ linters:
- revive
linters-settings:
errcheck:
# report about assignment of errors to blank
# identifier: `num, _ := strconv.Atoi(numStr)`;
# report about assignment of errors to blank identifier
# default is false: such cases aren't reported by default.
check-blank: true
govet:

View file

@ -3,10 +3,10 @@
## Hadolint config file ##
##########################
ignored:
- DL4001 # Ignore wget and curl in same file
- DL4006 # ignore pipefail as we dont want to add layers
- DL3018 # We do pin version in pipfile.lock
- DL3013 # We do pin version in pipfile.lock
- DL3003 # Ignore workdir so we dont add layers
- SC2016 # ignore as its intepreted later
- DL3044 # Ignore using env in env
- DL4001 # Ignore wget and curl in same file
- DL4006 # ignore pipefail as we don't want to add layers
- DL3018 # We do pin version in pipfile.lock
- DL3013 # We do pin version in pipfile.lock
- DL3003 # Ignore workdir so we don't add layers
- SC2016 # ignore as its interpreted later
- DL3044 # Ignore using env in env

View file

@ -50,7 +50,7 @@ rules:
key-duplicates: enable
line-length:
level: warning
max: 600
max: 1024
allow-non-breakable-words: true
allow-non-breakable-inline-mappings: true
new-line-at-end-of-file: disable

View file

@ -1,5 +1,4 @@
---
# yamllint disable rule:line-length
name-template: 'v$RESOLVED_VERSION'
tag-template: 'v$RESOLVED_VERSION'
template: |

View file

@ -202,5 +202,6 @@ jobs:
-e OUTPUT_DETAILS=detailed \
-e ACTIONS_RUNNER_DEBUG=true \
-e ERROR_ON_MISSING_EXEC_BIT=true \
-e YAML_LINTER_RULES=.github/linters/.yaml-linter.yml \
-v "${GITHUB_WORKSPACE}:/tmp/lint" \
"ghcr.io/github/super-linter:slim-${GITHUB_SHA}"

View file

@ -201,5 +201,6 @@ jobs:
-e OUTPUT_DETAILS=detailed \
-e ACTIONS_RUNNER_DEBUG=true \
-e ERROR_ON_MISSING_EXEC_BIT=true \
-e YAML_LINTER_RULES=.github/linters/.yaml-linter.yml \
-v "${GITHUB_WORKSPACE}:/tmp/lint" \
"ghcr.io/github/super-linter:${GITHUB_SHA}"

View file

@ -16,7 +16,6 @@
on:
pull_request:
###############
# Set the Job #
###############

View file

@ -8,7 +8,7 @@
#############################
# Exclude paths from linter #
#############################
#exclude_paths:
# exclude_paths:
########################
# Make output parsable #
@ -23,23 +23,23 @@ quiet: true
#####################
# Path to rules dir #
#####################
#rulesdir:
# rulesdir:
################
# Tags to skip #
################
skip_list:
- 'empty-string-compare' # Allow compare to empty string
- '204' # Allow string length greater than 160 chars
- 'no-changed-when' # False positives for running command shells
- 'command-instead-of-module' # Allow git commands for push, add, etc...
- 'command-instead-of-shell' # Allow use of shell when you want
- 'no-handler' # Allow step to run like handler
- 'empty-string-compare' # Allow compare to empty string
- '204' # Allow string length greater than 160 chars
- 'no-changed-when' # False positives for running command shells
- 'command-instead-of-module' # Allow git commands for push, add, etc...
- 'command-instead-of-shell' # Allow use of shell when you want
- 'no-handler' # Allow step to run like handler
##################
# Tags to follow #
##################
#tags:
# tags:
#############
# Use rules #

View file

@ -1,5 +1,4 @@
---
#############################
#############################
## JavaScript Linter rules ##
@ -38,7 +37,7 @@ plugins:
#########
# Rules #
#########
# rules: {}
rules: { }
##############################
# Overrides for JSON parsing #