Fixed the super-linter warnings

netbox-community · Jul 13, 2022 · 86b68cb · 86b68cb
1 parent 166d587
commit 86b68cb
Show file tree

Hide file tree

Showing 4 changed files with 121 additions and 115 deletions.
diff --git a/.github/workflows/push.yml b/.github/workflows/push.yml
@@ -1,3 +1,4 @@
+---
 name: push
 
 on:
@@ -13,66 +14,67 @@ jobs:
     runs-on: ubuntu-latest
     name: Checks syntax of our code
     steps:
-    - uses: actions/checkout@v3
-      with:
-        # Full git history is needed to get a proper list of changed files within `super-linter`
-        fetch-depth: 0
-    - uses: actions/setup-python@v4
-      with:
-        python-version: '3.9'
-    - name: Lint Code Base
-      uses: github/super-linter@v4
-      env:
-        DEFAULT_BRANCH: develop
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        SUPPRESS_POSSUM: true
-        LINTER_RULES_PATH: /
-        VALIDATE_ALL_CODEBASE: false
-        VALIDATE_DOCKERFILE: false
-        FILTER_REGEX_EXCLUDE: (.*/)?(LICENSE|configuration/.*)
-
-        EDITORCONFIG_FILE_NAME: .ecrc
-        DOCKERFILE_HADOLINT_FILE_NAME: .hadolint.yaml
-        MARKDOWN_CONFIG_FILE: .markdown-lint.yml
-        PYTHON_BLACK_CONFIG_FILE: pyproject.toml
-        PYTHON_FLAKE8_CONFIG_FILE: .flake8
-        PYTHON_ISORT_CONFIG_FILE: pyproject.toml
+      - uses: actions/checkout@v3
+        with:
+          # Full git history is needed to get a proper
+          # list of changed files within `super-linter`
+          fetch-depth: 0
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'
+      - name: Lint Code Base
+        uses: github/super-linter@v4
+        env:
+          DEFAULT_BRANCH: develop
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SUPPRESS_POSSUM: true
+          LINTER_RULES_PATH: /
+          VALIDATE_ALL_CODEBASE: false
+          VALIDATE_DOCKERFILE: false
+          FILTER_REGEX_EXCLUDE: (.*/)?(LICENSE|configuration/.*)
+          EDITORCONFIG_FILE_NAME: .ecrc
+          DOCKERFILE_HADOLINT_FILE_NAME: .hadolint.yaml
+          MARKDOWN_CONFIG_FILE: .markdown-lint.yml
+          PYTHON_BLACK_CONFIG_FILE: pyproject.toml
+          PYTHON_FLAKE8_CONFIG_FILE: .flake8
+          PYTHON_ISORT_CONFIG_FILE: pyproject.toml
+          YAML_CONFIG_FILE: .yamllint.yaml
   build:
-    continue-on-error: ${{ matrix.docker_from == 'alpine:edge' }}
+    continue-on-error: ${{ matrix.build_cmd != './build-latest.sh' }}
     strategy:
       matrix:
         build_cmd:
-        - ./build-latest.sh
-        - PRERELEASE=true ./build-latest.sh
-        - ./build.sh feature
-        - ./build.sh develop
+          - ./build-latest.sh
+          - PRERELEASE=true ./build-latest.sh
+          - ./build.sh feature
+          - ./build.sh develop
         platform:
-        - linux/amd64
-        - linux/arm64
+          - linux/amd64
+          - linux/arm64
       fail-fast: false
     env:
       GH_ACTION: enable
       IMAGE_NAMES: docker.io/netboxcommunity/netbox
     runs-on: ubuntu-latest
     name: Builds new NetBox Docker Images
     steps:
-    - id: git-checkout
-      name: Checkout
-      uses: actions/checkout@v3
-    - id: qemu-setup
-      name: Set up QEMU
-      uses: docker/setup-qemu-action@v1
-    - id: buildx-setup
-      name: Set up Docker Buildx
-      uses: docker/setup-buildx-action@v1
-    - id: docker-build
-      name: Build the image for '${{ matrix.platform }}' with '${{ matrix.build_cmd }}'
-      run: ${{ matrix.build_cmd }}
-      env:
-        DOCKER_FROM: ${{ matrix.docker_from }}
-        BUILDX_PLATFORM: ${{ matrix.platform }}
-        BUILDX_BUILDER_NAME: ${{ steps.buildx-setup.outputs.name }}
-    - id: docker-test
-      name: Test the image
-      run: IMAGE="${FINAL_DOCKER_TAG}" ./test.sh
-      if: steps.docker-build.outputs.skipped != 'true'
+      - id: git-checkout
+        name: Checkout
+        uses: actions/checkout@v3
+      - id: qemu-setup
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+      - id: buildx-setup
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+      - id: docker-build
+        name: Build the image for '${{ matrix.platform }}' with '${{ matrix.build_cmd }}'
+        run: ${{ matrix.build_cmd }}
+        env:
+          DOCKER_FROM: ${{ matrix.docker_from }}
+          BUILDX_PLATFORM: ${{ matrix.platform }}
+          BUILDX_BUILDER_NAME: ${{ steps.buildx-setup.outputs.name }}
+      - id: docker-test
+        name: Test the image
+        run: IMAGE="${FINAL_DOCKER_TAG}" ./test.sh
+        if: steps.docker-build.outputs.skipped != 'true'
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,3 +1,4 @@
+---
 name: release
 
 on:
@@ -13,71 +14,70 @@ jobs:
     strategy:
       matrix:
         build_cmd:
-        - ./build-latest.sh
-        - PRERELEASE=true ./build-latest.sh
-        - ./build.sh feature
-        - ./build.sh develop
+          - ./build-latest.sh
+          - PRERELEASE=true ./build-latest.sh
+          - ./build.sh feature
+          - ./build.sh develop
         platform:
-        - linux/amd64,linux/arm64
+          - linux/amd64,linux/arm64
       fail-fast: false
     runs-on: ubuntu-latest
     name: Builds new NetBox Docker Images
     env:
       GH_ACTION: enable
       IMAGE_NAMES: docker.io/netboxcommunity/netbox quay.io/netboxcommunity/netbox ghcr.io/netbox-community/netbox
     steps:
-    - id: source-checkout
-      name: Checkout
-      uses: actions/checkout@v3
-    - id: set-netbox-docker-version
-      name: Get Version of NetBox Docker
-      run: |
-        echo "::set-output name=version::$(cat VERSION)"
-      shell: bash
-    - id: qemu-setup
-      name: Set up QEMU
-      uses: docker/setup-qemu-action@v1
-    - id: buildx-setup
-      name: Set up Docker Buildx
-      uses: docker/setup-buildx-action@v1
-    - id: docker-build
-      name: Build the image with '${{ matrix.build_cmd }}'
-      run: ${{ matrix.build_cmd }}
-    - id: test-image
-      name: Test the image
-      run: IMAGE="${FINAL_DOCKER_TAG}" ./test.sh
-      if: steps.docker-build.outputs.skipped != 'true'
-    # docker.io
-    - id: docker-io-login
-      name: Login to docker.io
-      uses: docker/login-action@v2
-      with:
-        registry: docker.io
-        username: ${{ secrets.dockerhub_username }}
-        password: ${{ secrets.dockerhub_password }}
-      if: steps.docker-build.outputs.skipped != 'true'
-    # quay.io
-    - id: quay-io-login
-      name: Login to Quay.io
-      uses: docker/login-action@v2
-      with:
-        registry: quay.io
-        username: ${{ secrets.quayio_username }}
-        password: ${{ secrets.quayio_password }}
-      if: steps.docker-build.outputs.skipped != 'true'
-    # ghcr.io
-    - id: ghcr-io-login
-      name: Login to GitHub Container Registry
-      uses: docker/login-action@v2
-      with:
-        registry: ghcr.io
-        username: ${{ github.repository_owner }}
-        password: ${{ secrets.GITHUB_TOKEN }}
-      if: steps.docker-build.outputs.skipped != 'true'
-    - id: build-and-push
-      name: Push the image
-      run: ${{ matrix.build_cmd }} --push
-      if: steps.docker-build.outputs.skipped != 'true'
-      env:
-        BUILDX_PLATFORM: ${{ matrix.platform }}
-        BUILDX_BUILDER_NAME: ${{ steps.buildx-setup.outputs.name }}
+      - id: source-checkout
+        name: Checkout
+        uses: actions/checkout@v3
+      - id: set-netbox-docker-version
+        name: Get Version of NetBox Docker
+        run: echo "::set-output name=version::$(cat VERSION)"
+        shell: bash
+      - id: qemu-setup
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+      - id: buildx-setup
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+      - id: docker-build
+        name: Build the image with '${{ matrix.build_cmd }}'
+        run: ${{ matrix.build_cmd }}
+      - id: test-image
+        name: Test the image
+        run: IMAGE="${FINAL_DOCKER_TAG}" ./test.sh
+        if: steps.docker-build.outputs.skipped != 'true'
+      # docker.io
+      - id: docker-io-login
+        name: Login to docker.io
+        uses: docker/login-action@v2
+        with:
+          registry: docker.io
+          username: ${{ secrets.dockerhub_username }}
+          password: ${{ secrets.dockerhub_password }}
+        if: steps.docker-build.outputs.skipped != 'true'
+      # quay.io
+      - id: quay-io-login
+        name: Login to Quay.io
+        uses: docker/login-action@v2
+        with:
+          registry: quay.io
+          username: ${{ secrets.quayio_username }}
+          password: ${{ secrets.quayio_password }}
+        if: steps.docker-build.outputs.skipped != 'true'
+      # ghcr.io
+      - id: ghcr-io-login
+        name: Login to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+        if: steps.docker-build.outputs.skipped != 'true'
+      - id: build-and-push
+        name: Push the image
+        run: ${{ matrix.build_cmd }} --push
+        if: steps.docker-build.outputs.skipped != 'true'
+        env:
+          BUILDX_PLATFORM: ${{ matrix.platform }}
+          BUILDX_BUILDER_NAME: ${{ steps.buildx-setup.outputs.name }}
diff --git a/.yamllint.yaml b/.yamllint.yaml
@@ -0,0 +1,5 @@
+---
+
+rules:
+  line-length:
+    max: 120
diff --git a/build.sh b/build.sh
@@ -231,7 +231,6 @@ develop)
   ;;
 esac
 
-
 ###
 # composing the final TARGET_DOCKER_TAG
 ###
@@ -291,7 +290,7 @@ elif [[ "${IMAGE_NAME_TAGS[0]}" = docker.io* ]]; then
     # Need to use "library/..." for images the have no two part name
     DOCKER_FROM_SPLIT[0]="library/${DOCKER_FROM_SPLIT[0]}"
   fi
-  IFS='/' read -ra ORG_REPO <<< "${IMAGE_NAMES[0]}"
+  IFS='/' read -ra ORG_REPO <<<"${IMAGE_NAMES[0]}"
   echo "Checking labels for '${ORG_REPO[1]}' and '${ORG_REPO[2]}'"
   BASE_LAST_LAYER=$(get_image_last_layer "${DOCKER_FROM_SPLIT[0]}" "${DOCKER_FROM_SPLIT[1]}")
   mapfile -t IMAGES_LAYERS_OLD < <(get_image_layers "${ORG_REPO[1]}"/"${ORG_REPO[2]}" "${TAG}")
@@ -311,7 +310,7 @@ elif [[ "${IMAGE_NAME_TAGS[0]}" = docker.io* ]]; then
     BUILD_REASON="${BUILD_REASON} netbox-docker"
   fi
 else
-  SHOULD_BUILD="true" 
+  SHOULD_BUILD="true"
   BUILD_REASON="${BUILD_REASON} no-check"
 fi
 
@@ -413,7 +412,7 @@ $DRY docker buildx \
   .
 echo "✅ Finished building the Docker images"
 gh_echo "::endgroup::" # End group for Build
-      
+
 gh_echo "::group::🏗 Image Labels"
 echo "🔎 Inspecting labels on '${IMAGE_NAME_TAGS[0]}'"
 $DRY docker inspect "${IMAGE_NAME_TAGS[0]}" --format "{{json .Config.Labels}}" | jq