add backstage rule for catalog-info schema validation

rules/common/backstage.ts

@@ -0,0 +1,28 @@
+import { danger, fail } from "danger"
+import { validate } from "@roadiehq/roadie-backstage-entity-validator"
+
+const backstage = async () => {
+  const pr = danger.github.pr
+  const utils = danger.github.utils
+
+  const isOpen = pr.state === "open"
+
+  if (!isOpen) {
+    return
+  }
+
+  const filePath = "catalog-info.yaml"
+  const fileContent = await utils.fileContents(filePath, `${pr.head.user.login}/${pr.head.repo.name}`, pr.head.sha)
+
+  if (fileContent) {
+    try {
+      await validate(fileContent, true, "./schemas/backstage.annotations.json")
+    } catch (e) {
+      fail(`The 'catalog-info.yaml' file is not valid for Backstage. Error details:\n\n\`\`\`\n${e}\n\`\`\``)
+    }
+  } else {
+    fail(`The '${filePath}' file doesn't exist in the pull request.`)
+  }
+}
+
+export default backstage

rules/common/index.ts

@@ -4,6 +4,7 @@ import mergeCommits from "./mergeCommits"
 import changelog from "./changelog"
 import testsUpdated from "./testsUpdated"
 import notificationHubTemplate from "./notificationHubTemplate"
+import backstage from "./backstage"
 
 // Default run
 export default async () => {
@@ -13,4 +14,5 @@ export default async () => {
   await changelog()
   testsUpdated()
   await notificationHubTemplate()
+  await backstage()
 }

settings-peril.json

@@ -5,7 +5,7 @@
   },
   "rules": {
     "pull_request.opened": ["rules/common/approveReleasePR.ts", "rules/common/changelog.ts"],
-    "pull_request.synchronize": "rules/common/changelog.ts",
+    "pull_request.synchronize": ["rules/common/changelog.ts", "rules/common/backstage.ts"],
     "pull_request.closed": "rules/common/deleteMergedPRBranch.ts",
     "issue_comment.created": [
       "rules/common/markAsMergeOnGreen.ts",