Merge pull request #10 from github/upstream

Upstream

Author: zkoppert

.devcontainer/devcontainer.json

@@ -3,10 +3,15 @@
   "image": "ghcr.io/super-linter/super-linter:latest",
   "customizations": {
     "vscode": {
-      "settings": {},
+      "settings": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode",
+        "editor.wordWrap": "off",
+        "prettier.resolveGlobalModules": true
+      },
       "extensions": [
         "DavidAnson.vscode-markdownlint",
         "EditorConfig.EditorConfig",
+        "esbenp.prettier-vscode",
         "GitHub.vscode-github-actions",
         "GitHub.vscode-pull-request-github",
         "mads-hartmann.bash-ide-vscode",
@@ -24,18 +29,10 @@
       "type": "bind"
     },
     {
-      "source": "${localWorkspaceFolder}/lib/linter.sh",
-      "target": "/action/lib/linter.sh",
-      "type": "bind"
-    },
-    {
-      "source": "${localWorkspaceFolder}/lib/functions",
-      "target": "/action/lib/functions",
+      "source": "${localWorkspaceFolder}/lib",
+      "target": "/action/lib",
       "type": "bind"
     }
   ],
-  "runArgs": [
-    "--env-file",
-    ".devcontainer/devcontainer.env"
-  ]
+  "runArgs": ["--env-file", ".devcontainer/devcontainer.env"]
 }

.editorconfig

@@ -33,3 +33,9 @@ indent_size = 4
 # Disable the filename rule because our test case logic requires that files used in test cases
 # follow a certain syntax which is not compatible with what ktlint currently mandates (PascalCase)
 disabled_rules = filename
+
+[*.md]
+
+# Indentation in Markdown files might not be constant, or a multiple of 2.
+# Prettier takes care of formatting Markdown files.
+indent_size = unset

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -13,8 +13,34 @@ body:
       label: Is there an existing issue for this?
       description: Search to see if an issue already exists for the bug you encountered.
       options:
-      - label: I have searched the existing issues
-        required: true
+        - label: I have searched the existing issues
+          required: true
+  - type: checkboxes
+    attributes:
+      label: Are you using the latest Super-linter version available?
+      description: |
+        Ensure that you're using the latest Super-linter version.
+        https://github.com/super-linter/super-linter/releases/latest
+      options:
+        - label: I am using the latest Super-linter version.
+          required: true
+        - label: |
+            I can reproduce the issue running Super-linter using complete version identifier (example: vX.Y.Z), and not just with a partial one (example: vX)
+          required: true
+        - label: |
+            I am using the super-linter/super-linter action or container image, and not the deprecated github/super-linter action or container image.
+          required: true
+  - type: checkboxes
+    attributes:
+      label: Are you resonably sure that it's a Super-linter issue, and not an issue related to a tool that Super-linter runs?
+      description: |
+        If you encounter a specific issue, ensure that the issue is about
+        Super-linter, and not about a tool that Super-linter runs. For example,
+        if a linter reports an unexpected or a surprising error, you may check
+        if there are similar issues reported in that linter's issue tracker.
+      options:
+        - label: I think that this is a Super-linter issue.
+          required: true
   - type: textarea
     attributes:
       label: Current Behavior
@@ -33,10 +59,33 @@ body:
       description: |
         Super-Linter version where you observed this issue
       placeholder: |
-          vX.Y.Z
+        vX.Y.Z
       render: markdown
     validations:
       required: true
+  - type: textarea
+    attributes:
+      label: Super-linter configuration
+      description: |
+        How you configured Super-linter to experience the issue.
+        If running on GitHub Actions, include the actions/checkout step
+        as well.
+      placeholder: |
+        - name: Checkout code
+          uses: actions/checkout@v4
+          with:
+            fetch-depth: 0
+
+        - name: Super-linter
+          uses: super-linter/[email protected]
+          env:
+            # To report GitHub Actions status checks
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+            ........
+            ........
+      render: yaml
+    validations:
+      required: true
   - type: textarea
     id: logs
     attributes:
@@ -45,6 +94,7 @@ body:
         Copy and paste any relevant log output.
         This will be automatically formatted into code, so no need for backticks.
         Enable debug logging, either on GitHub Actions, or when running locally.
+        Not attaching debug logging will delay the issue triaging process.
       render: shell
     validations:
       required: true
@@ -67,7 +117,5 @@ body:
       label: Anything else?
       description: |
         Links? References? Anything that will give us more context about the issue you are encountering!
-
-        Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
     validations:
       required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -1,3 +1,2 @@
 ---
 blank_issues_enabled: false
-...

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -16,8 +16,8 @@ body:
       label: Is there an existing issue for this?
       description: Search to see if an issue already exists for the bug you encountered.
       options:
-      - label: I have searched the existing issues
-        required: true
+        - label: I have searched the existing issues
+          required: true
   - type: textarea
     attributes:
       label: Current Behavior
@@ -34,10 +34,6 @@ body:
     attributes:
       label: Anything else?
       description: |
-        Links? References? Anything that will give us more context about the issue you are encountering!
-
-        Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+        Links? References? Anything that will give us more context about the issue you are encountering.
     validations:
       required: false
-
----

.github/dependabot.yml

@@ -4,16 +4,17 @@
 #################################
 version: 2
 updates:
-
   - package-ecosystem: "devcontainers"
+    commit-message:
+      prefix: "chore(devcontainer)"
     directory: "/"
     schedule:
       interval: weekly
     open-pull-requests-limit: 100
 
   - package-ecosystem: github-actions
     commit-message:
-      prefix: "deps(github-actions)"
+      prefix: "ci(github-actions)"
     directory: "/"
     schedule:
       interval: "weekly"
@@ -77,15 +78,15 @@ updates:
 
   - package-ecosystem: "docker"
     commit-message:
-      prefix: "deps(dev-docker)"
+      prefix: "ci(dev-docker)"
     directory: "/dev-dependencies"
     schedule:
       interval: "weekly"
     open-pull-requests-limit: 100
 
   - package-ecosystem: "npm"
     commit-message:
-      prefix: "deps(dev-npm)"
+      prefix: "ci(dev-npm)"
     directory: "/dev-dependencies"
     schedule:
       interval: "weekly"

.github/linters/.cfnlintrc.yml

@@ -5,5 +5,3 @@ directory:
   - test/linters/checkov/bad
 
 quiet: false
-
-...

.github/linters/.checkov-test-linters-failure.yaml

@@ -5,4 +5,17 @@ directory:
   - test/linters/checkov/good
 
 quiet: false
-...
+
+skip-framework:
+  # The Kubernetes framework because it doesn't run Kustomize before running the
+  # scan, as expected. There's the Kustomize framework for that.
+  # If we don't skip the Kubernetes framework, Checkov reports issues against
+  # Kubernetes descriptors that we handle with Kustomize. For example, we set
+  # a non-default Kubernetes Namespace using Kustomize.
+  # Checkov doesn't currently support skipping checks only for a given set of
+  # frameworks, and the Kubernetes framework runs the same checks that the Helm
+  # and the Kustomize frameworks run. So, we skip the Kubernetes framework when
+  # running test cases. In case we need to implement new Kubernetes test cases,
+  # we have to do that as part of the test Helm chart or the test Kustomize
+  # "package".
+  - kubernetes

.github/linters/.checkov-test-linters-success.yaml

@@ -17,7 +17,9 @@ quiet: true
 skip-path:
   - test/linters/ansible
   - test/linters/arm
-  - test/linters/checkov/bad
+  # We can't exclude just test/linters/checkov/bad because of
+  # https://github.com/bridgecrewio/checkov/issues/6468
+  - test/linters/checkov
   - test/linters/dockerfile_hadolint
   - test/linters/jscpd
   - test/linters/json
@@ -26,4 +28,3 @@ skip-path:
   - test/linters/terraform_fmt
   - test/linters/terraform_tflint
   - test/linters/terraform_terrascan
-...