repolinter: custom gunyah repolinter config

This adds a local repolint.json config for Gunyah. Signed-off-by: Carl van Schaik <quic_cvanscha@quicinc.com>
shqli · Jun 18, 2023 · 3d40144 · 3d40144
1 parent f6e5204
commit 3d40144
Show file tree

Hide file tree

Showing 2 changed files with 317 additions and 0 deletions.
diff --git a/.github/workflows/quic-organization-repolinter.yml b/.github/workflows/quic-organization-repolinter.yml
@@ -19,6 +19,8 @@ jobs:
           files: "repolint.json"
       - name: Run Repolinter with local repolint.json
         if: steps.check_files.outputs.files_exists == 'true'
+        with:
+          config_file: "repolint.json"
         uses: newrelic/repolinter-action@v1
       - name: Run Repolinter with default ruleset
         if: steps.check_files.outputs.files_exists == 'false'

diff --git a/repolint.json b/repolint.json
@@ -0,0 +1,315 @@
+{
+  "$schema": "https://raw.githubusercontent.com/todogroup/repolinter/master/rulesets/schema.json",
+  "version": 2,
+  "axioms": {
+    "linguist": "language",
+    "licensee": "license",
+    "packagers": "packager"
+  },
+  "rules": {
+    "license-file-exists": {
+      "level": "error",
+      "rule": {
+        "type": "file-existence",
+        "options": {
+          "globsAny": [
+            "LICENSE*"
+          ],
+          "nocase": true
+        }
+      }
+    },
+    "readme-file-exists": {
+      "level": "error",
+      "rule": {
+        "type": "file-existence",
+        "options": {
+          "globsAny": [
+            "README*"
+          ],
+          "nocase": true
+        }
+      }
+    },
+    "contributing-file-exists": {
+      "level": "warning",
+      "rule": {
+        "type": "file-existence",
+        "options": {
+          "globsAny": [
+            "CONTRIBUTING*"
+          ],
+          "nocase": true
+        }
+      }
+    },
+    "code-of-conduct-file-exists": {
+      "level": "warning",
+      "rule": {
+        "type": "file-existence",
+        "options": {
+          "globsAny": [
+            "CODE-OF-CONDUCT*"
+          ],
+          "nocase": true
+        }
+      }
+    },
+    "changelog-file-exists": {
+      "level": "warning",
+      "rule": {
+        "type": "file-existence",
+        "options": {
+          "globsAny": [
+            "CHANGELOG*"
+          ],
+          "nocase": true
+        }
+      }
+    },
+    "readme-references-license": {
+      "level": "error",
+      "rule": {
+        "type": "file-contents",
+        "options": {
+          "globsAll": [
+            "README*"
+          ],
+          "content": "license",
+          "flags": "i"
+        }
+      }
+    },
+    "binaries-not-present": {
+      "level": "warning",
+      "rule": {
+        "type": "file-type-exclusion",
+        "options": {
+          "type": [
+            "**/*.exe",
+            "**/*.dll",
+            "**/*.o",
+            "**/*.so",
+            "!node_modules/**"
+          ]
+        }
+      }
+    },
+    "integrates-with-ci": {
+      "level": "warning",
+      "rule": {
+        "type": "file-existence",
+        "options": {
+          "globsAny": [
+            ".gitlab-ci.yml",
+            ".travis.yml",
+            "appveyor.yml",
+            ".appveyor.yml",
+            "circle.yml",
+            ".circleci/config.yml",
+            "Jenkinsfile",
+            ".drone.yml",
+            ".github/workflows/*",
+            "azure-pipelines.yml"
+          ]
+        }
+      }
+    },
+    "source-license-headers-exist": {
+      "level": "error",
+      "rule": {
+        "type": "file-starts-with",
+        "options": {
+          "globsAll": [
+            "**/*.py",
+            "**/*.js",
+            "**/*.c",
+            "**/*.cc",
+            "**/*.cpp",
+            "**/*.h",
+            "**/*.ts",
+            "**/*.sh",
+            "**/*.rs"
+          ],
+          "skip-paths-matching": {
+            "patterns": [
+              "qcbor/.*\\.[ch]"
+            ]
+          },
+          "lineCount": 20,
+          "patterns": [
+            "© 20[2-9][0-9] Qualcomm Innovation Center, Inc",
+            "SPDX-License-Identifier"
+          ],
+          "flags": "i"
+        }
+      }
+    },
+    "github-issue-template-exists": {
+      "level": "warning",
+      "rule": {
+        "type": "file-existence",
+        "options": {
+          "globsAny": [
+            "ISSUE_TEMPLATE*",
+            ".github/ISSUE_TEMPLATE*"
+          ]
+        }
+      }
+    },
+    "github-pull-request-template-exists": {
+      "level": "warning",
+      "rule": {
+        "type": "file-existence",
+        "options": {
+          "globsAny": [
+            "PULL_REQUEST_TEMPLATE*",
+            ".github/PULL_REQUEST_TEMPLATE*"
+          ]
+        }
+      }
+    },
+    "javascript-package-metadata-exists": {
+      "level": "warning",
+      "where": [
+        "language=javascript"
+      ],
+      "rule": {
+        "type": "file-existence",
+        "options": {
+          "globsAny": [
+            "package.json"
+          ]
+        }
+      }
+    },
+    "ruby-package-metadata-exists": {
+      "level": "warning",
+      "where": [
+        "language=ruby"
+      ],
+      "rule": {
+        "type": "file-existence",
+        "options": {
+          "globsAny": [
+            "Gemfile"
+          ]
+        }
+      }
+    },
+    "java-package-metadata-exists": {
+      "level": "warning",
+      "where": [
+        "language=java"
+      ],
+      "rule": {
+        "type": "file-existence",
+        "options": {
+          "globsAny": [
+            "pom.xml",
+            "build.xml",
+            "build.gradle"
+          ]
+        }
+      }
+    },
+    "python-package-metadata-exists": {
+      "level": "warning",
+      "where": [
+        "language=python"
+      ],
+      "rule": {
+        "type": "file-existence",
+        "options": {
+          "globsAny": [
+            "setup.py",
+            "requirements.txt"
+          ]
+        }
+      }
+    },
+    "rust-package-metadata-exists": {
+      "level": "error",
+      "where": [
+         "language=rust"
+      ],
+      "rule": {
+        "type": "file-existence",
+        "options": {
+          "globsAny": [
+            "Cargo.toml",
+            "Cargo.lock"
+          ]
+        }
+      }
+    },
+    "objective-c-package-metadata-exists": {
+      "level": "warning",
+      "where": [
+        "language=objective-c"
+      ],
+      "rule": {
+        "type": "file-existence",
+        "options": {
+          "globsAny": [
+            "Cartfile",
+            "Podfile",
+            "*.podspec"
+          ]
+        }
+      }
+    },
+    "swift-package-metadata-exists": {
+      "level": "warning",
+      "where": [
+        "language=swift"
+      ],
+      "rule": {
+        "type": "file-existence",
+        "options": {
+          "globsAny": [
+            "Package.swift"
+          ]
+        }
+      }
+    },
+    "erlang-package-metadata-exists": {
+      "level": "warning",
+      "where": [
+        "language=erlang"
+      ],
+      "rule": {
+        "type": "file-existence",
+        "options": {
+          "globsAny": [
+            "rebar.config"
+          ]
+        }
+      }
+    },
+    "elixir-package-metadata-exists": {
+      "level": "warning",
+      "where": [
+        "language=elixir"
+      ],
+      "rule": {
+        "type": "file-existence",
+        "options": {
+          "globsAny": [
+            "mix.exs"
+          ]
+        }
+      }
+    },
+    "license-detectable-by-licensee": {
+      "level": "off",
+      "where": [
+        "license=*"
+      ],
+      "rule": {
+        "type": "license-detectable-by-licensee",
+        "options": {}
+      }
+    }
+  }
+}