diff options
author | 2022-02-02 18:11:08 +0100 | |
---|---|---|
committer | 2022-02-02 18:11:08 +0100 | |
commit | 7d9ad0872c644c693bbb9e8864e2c19627586ad2 (patch) | |
tree | c4ff26e18424f37fe3650b4e85a6614e8186fffe | |
parent | 911891f48513eef99ba0c80fae0c1e89f70649fe (diff) | |
download | coredns-7d9ad0872c644c693bbb9e8864e2c19627586ad2.tar.gz coredns-7d9ad0872c644c693bbb9e8864e2c19627586ad2.tar.zst coredns-7d9ad0872c644c693bbb9e8864e2c19627586ad2.zip |
Cleanup yaml formatting (#5151)
* Add yamllint config.
* Add yamllint workflow.
* Cleanup linting issues.
* Remove unnecessary `set -x -e` from workflows.
Signed-off-by: SuperQ <superq@gmail.com>
-rw-r--r-- | .circleci/config.yml | 2 | ||||
-rw-r--r-- | .github/workflows/codeql-analysis.yml | 20 | ||||
-rw-r--r-- | .github/workflows/go.coverage.yml | 33 | ||||
-rw-r--r-- | .github/workflows/go.fmt.yml | 15 | ||||
-rw-r--r-- | .github/workflows/go.test.yml | 97 | ||||
-rw-r--r-- | .github/workflows/go.tidy.yml | 19 | ||||
-rw-r--r-- | .github/workflows/make.doc.yml | 20 | ||||
-rw-r--r-- | .github/workflows/whitespace.yml | 15 | ||||
-rw-r--r-- | .github/workflows/yamllint.yml | 18 | ||||
-rw-r--r-- | .stickler.yml | 12 | ||||
-rw-r--r-- | .yamllint | 17 |
11 files changed, 146 insertions, 122 deletions
diff --git a/.circleci/config.yml b/.circleci/config.yml index fa21b279d..7a848579d 100644 --- 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 index 524161be8..f82cf0020 100644 --- 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 index 9ea6cfb96..7d6f1425d 100644 --- 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/codecov-action@v2.1.0 + - name: Upload coverage to Codecov + uses: codecov/codecov-action@v2.1.0 diff --git a/.github/workflows/go.fmt.yml b/.github/workflows/go.fmt.yml index ae4912593..651a0f5db 100644 --- 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 "bot@bot.coredns.io" 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 index c536278b2..316cac1d6 100644 --- 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 index d5e8361ea..322a4c823 100644 --- 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 "bot@bot.coredns.io" 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 index 4ab9df5eb..66b36fe5e 100644 --- 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 "bot@bot.coredns.io" 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 index 26f9ba015..215996930 100644 --- 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 "bot@bot.coredns.io" 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 new file mode 100644 index 000000000..5dae64075 --- /dev/null +++ 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 index c2a68ce41..cf662ed94 100644 --- 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/*' diff --git a/.yamllint b/.yamllint new file mode 100644 index 000000000..1fd8ea1d8 --- /dev/null +++ b/.yamllint @@ -0,0 +1,17 @@ +--- +extends: default + +rules: + braces: + max-spaces-inside: 1 + level: error + brackets: + max-spaces-inside: 1 + level: error + document-start: disable + hyphens: + max-spaces-after: 1 + indentation: + spaces: 2 + line-length: disable + truthy: disable |