Cleanup yaml formatting (coredns#5151)

* Add yamllint config. * Add yamllint workflow. * Cleanup linting issues. * Remove unnecessary `set -x -e` from workflows. Signed-off-by: SuperQ <[email protected]>
aks-lts · Feb 2, 2022 · 7d9ad08 · 7d9ad08
1 parent 911891f
commit 7d9ad08
Show file tree

Hide file tree

Showing 11 changed files with 146 additions and 122 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -47,7 +47,7 @@ jobs:
       - checkout
       - run:
           name: Get CI repo
-          command : |
+          command: |
             mkdir -p ~/go/src/${CIRCLE_PROJECT_USERNAME}/ci
             git clone https://github.com/${CIRCLE_PROJECT_USERNAME}/ci ~/go/src/${CIRCLE_PROJECT_USERNAME}/ci
       - <<: *setupKubernetes

diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -19,16 +19,16 @@ jobs:
         language: [ 'go' ]
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
+      - name: Checkout repository
+        uses: actions/checkout@v2
 
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      with:
-        languages: ${{ matrix.language }}
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          languages: ${{ matrix.language }}
 
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v1
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1
diff --git a/.github/workflows/go.coverage.yml b/.github/workflows/go.coverage.yml
@@ -5,24 +5,23 @@ jobs:
     name: Coverage
     runs-on: ubuntu-latest
     steps:
+      - name: Install Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: '1.17.0'
+        id: go
 
-    - name: Install Go
-      uses: actions/setup-go@v2
-      with:
-        go-version: '1.17.0'
-      id: go
+      - name: Check out code
+        uses: actions/checkout@v2
 
-    - name: Check out code
-      uses: actions/checkout@v2
+      - name: Build
+        run: go build -v ./...
 
-    - name: Build
-      run: go build -v ./...
+      - name: Test With Coverage
+        run: |
+          for d in request core coremain plugin test; do \
+             ( cd $d; go test -coverprofile=cover.out -covermode=atomic -race ./...; [ -f cover.out ] && cat cover.out >> ../coverage.txt ); \
+          done
 
-    - name: Test With Coverage
-      run: |
-        for d in request core coremain plugin test; do \
-           ( cd $d; go test -coverprofile=cover.out -covermode=atomic -race ./...; [ -f cover.out ] && cat cover.out >> ../coverage.txt ); \
-        done
-
-    - name: Upload coverage to Codecov
-      uses: codecov/[email protected]
+      - name: Upload coverage to Codecov
+        uses: codecov/[email protected]
diff --git a/.github/workflows/go.fmt.yml b/.github/workflows/go.fmt.yml
@@ -8,23 +8,22 @@ jobs:
   fix:
     runs-on: ubuntu-latest
     steps:
-      -
-        name: Checkout
+      - name: Checkout
         uses: actions/checkout@v2
-      -
-        name: Fmt
+
+      - name: Fmt
         run: |
           find . -not -path '*/\.git/*' -type f -name '*.go' -exec gofmt -s -w {} \+
-      -
-        name: Set up Git
+
+      - name: Set up Git
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           git config user.name "coredns[bot]"
           git config user.email "[email protected]"
           git remote set-url origin https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
-      -
-        name: Commit and push changes
+
+      - name: Commit and push changes
         run: |
           git add .
           if output=$(git status --porcelain) && [ ! -z "$output" ]; then

diff --git a/.github/workflows/go.test.yml b/.github/workflows/go.test.yml
@@ -5,81 +5,76 @@ jobs:
     name: Test
     runs-on: ubuntu-latest
     steps:
+      - name: Install Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: '1.17.0'
+        id: go
 
-    - name: Install Go
-      uses: actions/setup-go@v2
-      with:
-        go-version: '1.17.0'
-      id: go
+      - name: Check out code
+        uses: actions/checkout@v2
 
-    - name: Check out code
-      uses: actions/checkout@v2
+      - name: Build
+        run: go build -v ./...
 
-    - name: Build
-      run: go build -v ./...
-
-    - name: Test
-      run: |
-        ( cd request; go test -race ./... )
-        ( cd core; go test -race  ./... )
-        ( cd coremain; go test -race ./... )
+      - name: Test
+        run: |
+          ( cd request; go test -race ./... )
+          ( cd core; go test -race  ./... )
+          ( cd coremain; go test -race ./... )
 
   test-plugins:
     name: Test Plugins
     runs-on: ubuntu-latest
     steps:
+      - name: Install Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: '1.17.0'
+        id: go
 
-    - name: Install Go
-      uses: actions/setup-go@v2
-      with:
-        go-version: '1.17.0'
-      id: go
-
-    - name: Check out code
-      uses: actions/checkout@v2
+      - name: Check out code
+        uses: actions/checkout@v2
 
-    - name: Build
-      run: go build -v ./...
+      - name: Build
+        run: go build -v ./...
 
-    - name: Test
-      run: ( cd plugin; go test -race ./... )
+      - name: Test
+        run: ( cd plugin; go test -race ./... )
 
   test-e2e:
     name: Test e2e
     runs-on: ubuntu-latest
     steps:
+      - name: Install Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: '1.17.0'
+        id: go
 
-    - name: Install Go
-      uses: actions/setup-go@v2
-      with:
-        go-version: '1.17.0'
-      id: go
+      - name: Check out code
+        uses: actions/checkout@v2
 
-    - name: Check out code
-      uses: actions/checkout@v2
+      - name: Build
+        run: go build -v ./...
 
-    - name: Build
-      run: go build -v ./...
-
-    - name: Test
-      run: |
-        go install github.com/fatih/faillint || true
-        ( cd test; go test -race ./... )
+      - name: Test
+        run: |
+          go install github.com/fatih/faillint || true
+          ( cd test; go test -race ./... )
 
   test-makefile-release:
     name: Test Makefile.release
     runs-on: ubuntu-latest
     steps:
+      - name: Install dependencies
+        run: sudo apt-get install make curl
 
-    - name: Install dependencies
-      run: |
-        sudo apt-get install make curl
-
-    - name: Check out code
-      uses: actions/checkout@v2
+      - name: Check out code
+        uses: actions/checkout@v2
 
-    - name: Test Makefile.release
-      run:  make GITHUB_ACCESS_TOKEN=x -n release github-push -f Makefile.release
+      - name: Test Makefile.release
+        run: make GITHUB_ACCESS_TOKEN=x -n release github-push -f Makefile.release
 
-    - name: Test Makefile.docker
-      run:  make VERSION=x DOCKER=x -n release docker-push -f Makefile.docker
+      - name: Test Makefile.docker
+        run: make VERSION=x DOCKER=x -n release docker-push -f Makefile.docker
diff --git a/.github/workflows/go.tidy.yml b/.github/workflows/go.tidy.yml
@@ -8,30 +8,29 @@ jobs:
   fix:
     runs-on: ubuntu-latest
     steps:
-      -
-        name: Install Go
+      - name: Install Go
         uses: actions/setup-go@v2
         with:
           go-version: '1.17.0'
         id: go
-      -
-        name: Checkout
+
+      - name: Checkout
         uses: actions/checkout@v2
-      -
-        name: Tidy
+
+      - name: Tidy
         run: |
           rm -f go.sum
           go mod tidy
-      -
-        name: Set up Git
+
+      - name: Set up Git
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           git config user.name "coredns[bot]"
           git config user.email "[email protected]"
           git remote set-url origin https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
-      -
-        name: Commit and push changes
+
+      - name: Commit and push changes
         run: |
           git add .
           if output=$(git status --porcelain) && [ ! -z "$output" ]; then

diff --git a/.github/workflows/make.doc.yml b/.github/workflows/make.doc.yml
@@ -8,31 +8,29 @@ jobs:
   fix:
     runs-on: ubuntu-latest
     steps:
-      -
-        name: Checkout
+      - name: Checkout
         uses: actions/checkout@v2
-      -
-        name: Setup Go
+
+      - name: Setup Go
         uses: actions/setup-go@v2
         with:
           go-version: '1.17.0'
-      -
-        name: Update Docs
+
+      - name: Update Docs
         run: |
           bash -x -e ./.github/fixup_file_mtime.sh
           make -f Makefile.doc
-      -
-        name: Set up Git
+
+      - name: Set up Git
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           git config user.name "coredns[bot]"
           git config user.email "[email protected]"
           git remote set-url origin https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
-      -
-        name: Commit and push changes
+
+      - name: Commit and push changes
         run: |
-          set -x -e
           git add .
           if output=$(git status --porcelain) && [ ! -z "$output" ]; then
             git commit -s -m 'auto make -f Makefile.doc'

diff --git a/.github/workflows/whitespace.yml b/.github/workflows/whitespace.yml
@@ -8,23 +8,22 @@ jobs:
   fix:
     runs-on: ubuntu-latest
     steps:
-      -
-        name: Checkout
+      - name: Checkout
         uses: actions/checkout@v2
-      -
-        name: Remove Trailing Whitespaces
+
+      - name: Remove Trailing Whitespaces
         run: |
           find . -not -path '*/\.git/*' -type f -not -name '*.go' -exec sed -i 's/[[:space:]]\{1,\}$//' {} \+
-      -
-        name: Set up Git
+
+      - name: Set up Git
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           git config user.name "coredns[bot]"
           git config user.email "[email protected]"
           git remote set-url origin https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
-      -
-        name: Commit and push changes
+
+      - name: Commit and push changes
         run: |
           git add .
           if output=$(git status --porcelain) && [ ! -z "$output" ]; then

diff --git a/.github/workflows/yamllint.yml b/.github/workflows/yamllint.yml
@@ -0,0 +1,18 @@
+name: 'Yamllint GitHub Actions'
+on:
+  - pull_request
+jobs:
+  yamllint:
+    name: 'Yamllint'
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout'
+        uses: actions/checkout@master
+      - name: 'Yamllint'
+        uses: karancode/yamllint-github-action@master
+        with:
+          yamllint_file_or_dir: '.'
+          yamllint_strict: false
+          yamllint_comment: true
+        env:
+          GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.stickler.yml b/.stickler.yml
@@ -1,10 +1,10 @@
 ---
 linters:
-    golint:
-        min_confidence: 0.85
-        fixer: true
+  golint:
+    min_confidence: 0.85
+    fixer: true
 
 files:
-    ignore:
-        - 'vendor/*'
-        - 'pb/*'
+  ignore:
+    - 'vendor/*'
+    - 'pb/*'