@backstage/repo-tools 0.3.3 → 0.3.4-next.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @backstage/repo-tools
 
+## 0.3.4-next.0
+
+### Patch Changes
+
+- 0109d3f11159: The `generate-catalog-info` command now uses the first listed `CODEOWNER` as Component owner when initially
+  creating the `catalog-info.yaml` file. It continues to allow any one listed `CODEOWNER` when updating
+  entity metadata.
+- ec13d3e86028: Fixed a bug with the `generate-catalog-info` command that could cause the `--dry-run` flag to indicate changes to files when no changes would actually be made if the command were run without the flag.
+- db60a16e0a54: Added a `--ci` flag to the `generate-catalog-info` command. This flag behaves similarly to the same flag on `api-reports`: if `catalog-info.yaml` files would have been added or modified, then the process exits with status code `1`, and instructions are printed.
+- Updated dependencies
+  - @backstage/catalog-model@1.4.1
+  - @backstage/cli-common@0.1.12
+  - @backstage/cli-node@0.1.3
+  - @backstage/errors@1.2.1
+
 ## 0.3.3
 
 ### Patch Changes

package/dist/cjs/{generate-catalog-info-84fe20dd.cjs.js → generate-catalog-info-52b0f2ff.cjs.js}

@@ -23,6 +23,8 @@ function isBackstagePackage(packageJson) {
   var _a;
   return packageJson && packageJson.hasOwnProperty("backstage") && ((_a = packageJson == null ? void 0 : packageJson.backstage) == null ? void 0 : _a.role) !== "undefined";
 }
+const isRejected = (input) => input.status === "rejected";
+const isFulfilled = (input) => input.status === "fulfilled";
 
 async function loadCodeowners() {
   const maybeFiles = await Promise.allSettled(
@@ -49,7 +51,7 @@ function getPossibleCodeowners(codeowners, relPath) {
 function getOwnerFromCodeowners(codeowners, absPath) {
   const relPath = path.relative(".", absPath);
   const possibleOwners = getPossibleCodeowners(codeowners, relPath);
-  const owner = possibleOwners.slice(-1)[0];
+  const owner = possibleOwners[0];
   if (!owner) {
     throw new Error(`${relPath} isn't owned by anyone in CODEOWNERS`);
   }
@@ -57,15 +59,17 @@ function getOwnerFromCodeowners(codeowners, absPath) {
 }
 
 var generateCatalogInfo = async (opts) => {
-  const { dryRun = false } = opts;
+  const { dryRun = false, ci = false } = opts;
   const packages = await cliNode.PackageGraph.listTargetPackages();
   const codeowners = await loadCodeowners();
   const limit = pLimit__default["default"](10);
+  const isDryRun = ci ? true : dryRun;
+  const checkForChanges = ci;
   const results = await Promise.allSettled(
     packages.map(
       ({ packageJson, dir }) => limit(async () => {
         if (!isBackstagePackage(packageJson)) {
-          return;
+          return "";
         }
         const infoYamlPath = path.resolve(dir, "catalog-info.yaml");
         let yamlString = "";
@@ -73,29 +77,27 @@ var generateCatalogInfo = async (opts) => {
           yamlString = await readFile(infoYamlPath, { encoding: "utf-8" });
         } catch (e) {
           if (e.code === "ENOENT") {
-            await createCatalogInfoYaml({
+            return await createCatalogInfoYaml({
               yamlPath: infoYamlPath,
               packageJson,
               codeowners,
-              dryRun
+              dryRun: isDryRun
             });
-            return;
           }
           throw e;
         }
-        await fixCatalogInfoYaml({
+        return await fixCatalogInfoYaml({
           yamlPath: infoYamlPath,
           packageJson,
           codeowners,
           yamlString,
-          dryRun
+          dryRun: isDryRun,
+          ci
         });
       })
     )
   );
-  const rejects = results.filter(
-    (r) => r.status === "rejected"
-  );
+  const rejects = results.filter(isRejected);
   if (rejects.length > 0) {
     console.error(
       chalk__default["default"].red("Unable to create or fix catalog-info.yaml files\n")
@@ -104,16 +106,35 @@ var generateCatalogInfo = async (opts) => {
     console.error();
     process.exit(1);
   }
+  if (checkForChanges) {
+    const instructions = results.filter(isFulfilled).map((r) => r.value).filter((r) => r !== "");
+    if (instructions.length > 0) {
+      console.error(
+        "\ncatalog-info.yaml file(s) out of sync with CODEOWNERS and/or package.json (see instructions above)\n"
+      );
+      process.exit(1);
+    } else {
+      console.error(
+        "catalog-info.yaml file(s) in sync with CODEOWNERS and package.json"
+      );
+    }
+  }
 };
-function createCatalogInfoYaml(options) {
+async function createCatalogInfoYaml(options) {
   const { codeowners, dryRun, packageJson, yamlPath } = options;
+  const instruction = `Create ${path.relative(".", yamlPath)}`;
   const owner = getOwnerFromCodeowners(codeowners, yamlPath);
   const entity = createOrMergeEntity(packageJson, owner);
-  return dryRun ? Promise.resolve(console.error(`Create ${path.relative(".", yamlPath)}`)) : writeFile(yamlPath, YAML__default["default"].dump(entity));
+  if (dryRun) {
+    console.error(instruction);
+  } else {
+    await writeFile(yamlPath, YAML__default["default"].dump(entity));
+  }
+  return instruction;
 }
-function fixCatalogInfoYaml(options) {
+async function fixCatalogInfoYaml(options) {
   var _a, _b, _c;
-  const { codeowners, dryRun, packageJson, yamlPath, yamlString } = options;
+  const { ci, codeowners, dryRun, packageJson, yamlPath, yamlString } = options;
   const possibleOwners = getPossibleCodeowners(
     codeowners,
     path.relative(".", yamlPath)
@@ -129,13 +150,42 @@ function fixCatalogInfoYaml(options) {
   const badTitle = yamlJson.metadata.title !== packageJson.name;
   const badName = yamlJson.metadata.name !== safeName;
   const badType = ((_b = yamlJson.spec) == null ? void 0 : _b.type) !== `backstage-${packageJson.backstage.role}`;
-  const badDesc = yamlJson.metadata.description !== packageJson.description;
-  if (badOwner || badTitle || badName || badType || badDesc) {
+  if (badOwner || badTitle || badName || badType) {
     const owner = badOwner ? getOwnerFromCodeowners(codeowners, yamlPath) : (_c = yamlJson.spec) == null ? void 0 : _c.owner;
     const newJson = createOrMergeEntity(packageJson, owner, yamlJson);
-    return dryRun ? Promise.resolve(console.error(`Update ${path.relative(".", yamlPath)}`)) : writeFile(yamlPath, yamlDiffPatch.yamlOverwrite(yamlString, newJson));
+    const instructions = [`Update ${path.relative(".", yamlPath)}`];
+    if (ci) {
+      if (badOwner) {
+        instructions.push(
+          `  spec.owner cannot be "${yamlJson.spec.owner}" because it must be one of (${possibleOwners.join(
+            ", "
+          )}) as listed in CODEOWNERS`
+        );
+      }
+      if (badTitle) {
+        instructions.push(
+          `  metadata.title cannot be "${yamlJson.metadata.title}" because it must be exactly "${packageJson.name}", the package.json name`
+        );
+      }
+      if (badName) {
+        instructions.push(
+          `  metadata.name cannot be "${yamlJson.metadata.name}" because it must be exactly "${safeName}", as derived from package.json name`
+        );
+      }
+      if (badType) {
+        instructions.push(
+          `  spec.type cannot be "${yamlJson.spec.type}" because it must be exactly "backstage-${packageJson.backstage.role}", as derived from package.json backstage.role`
+        );
+      }
+    }
+    if (dryRun) {
+      console.error(instructions.join("\n"));
+    } else {
+      await writeFile(yamlPath, yamlDiffPatch.yamlOverwrite(yamlString, newJson));
+    }
+    return instructions.join("\n");
   }
-  return Promise.resolve();
+  return "";
 }
 function createOrMergeEntity(packageJson, owner, existingEntity = {}) {
   const safeEntityName = packageJson.name.replace(/[^a-z0-9_\-\.]+/g, "-").replace(/^[^a-z0-9]|[^a-z0-9]$/g, "");
@@ -160,4 +210,4 @@ function createOrMergeEntity(packageJson, owner, existingEntity = {}) {
 }
 
 exports["default"] = generateCatalogInfo;
-//# sourceMappingURL=generate-catalog-info-84fe20dd.cjs.js.map
+//# sourceMappingURL=generate-catalog-info-52b0f2ff.cjs.js.map

package/dist/index.cjs.js

@@ -89,9 +89,12 @@ function registerCommands(program) {
   program.command("generate-catalog-info").option(
     "--dry-run",
     "Shows what would happen without actually writing any yaml."
+  ).option(
+    "--ci",
+    "CI run checks that there are no changes to catalog-info.yaml files"
   ).description("Create or fix info yaml files for all backstage packages").action(
     lazy(
-      () => Promise.resolve().then(function () { return require('./cjs/generate-catalog-info-84fe20dd.cjs.js'); }).then(
+      () => Promise.resolve().then(function () { return require('./cjs/generate-catalog-info-52b0f2ff.cjs.js'); }).then(
         (m) => m.default
       )
     )
@@ -111,7 +114,7 @@ function lazy(getActionFunc) {
   };
 }
 
-var version = "0.3.3";
+var version = "0.3.4-next.0";
 
 const main = (argv) => {
   commander.program.name("backstage-repo-tools").version(version);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/repo-tools",
   "description": "CLI for Backstage repo tooling ",
-  "version": "0.3.3",
+  "version": "0.3.4-next.0",
   "publishConfig": {
     "access": "public"
   },
@@ -60,7 +60,7 @@
     "yaml-diff-patch": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.10",
+    "@backstage/cli": "^0.22.12-next.0",
     "@backstage/types": "^1.1.0",
     "@types/is-glob": "^4.0.2",
     "@types/mock-fs": "^4.13.0",