feat(janus-idp/cli): package-dynamic-plugins update annotations (#2609)

* feat(janus-idp/cli): package-dynamic-plugins update annotations - rename com.redhat.rhdh.plugins to io.backstage.dynamic-packages to make it more "upstream friendly" - add io.backstage.marketplace/<plugin-name> annotations, value is read from file specified by optional --marketplace flag - use base64 for anotation values Signed-off-by: Tomas Kral <[email protected]> * add changeset * fix typos --------- Signed-off-by: Tomas Kral <[email protected]>
janus-idp · Jan 9, 2025 · eac5451 · eac5451
1 parent 37f0b43
commit eac5451
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 2 deletions.
diff --git a/.changeset/flat-avocados-appear.md b/.changeset/flat-avocados-appear.md
@@ -0,0 +1,8 @@
+---
+"@janus-idp/cli": major
+---
+changes to package-dynamic-plugins command:
+
+- rename com.redhat.rhdh.plugins to io.backstage.dynamic-packages to make it more "upstream friendly"
+- add io.backstage.marketplace/<plugin-name> annotations, value is read from file specified by optional --marketplace flag
+- use base64 for annotation values
diff --git a/packages/cli/src/commands/index.ts b/packages/cli/src/commands/index.ts
@@ -186,6 +186,10 @@ export function registerScriptCommand(program: Command) {
       'By defult, the command uses podman to build the container image. Use this flag to use docker instead.',
       false,
     )
+    .option(
+      '-m, --marketplace-file <file>',
+      'Marketplace yaml file. This is a Plugin entity definition for Marketplace.',
+    )
     .action(
       lazy(() => import('./package-dynamic-plugins').then(m => m.command)),
     );

diff --git a/packages/cli/src/commands/package-dynamic-plugins/command.ts b/packages/cli/src/commands/package-dynamic-plugins/command.ts
@@ -13,7 +13,14 @@ import { paths } from '../../lib/paths';
 import { Task } from '../../lib/tasks';
 
 export async function command(opts: OptionValues): Promise<void> {
-  const { exportTo, forceExport, preserveTempDir, tag, useDocker } = opts;
+  const {
+    exportTo,
+    forceExport,
+    preserveTempDir,
+    tag,
+    useDocker,
+    marketplaceFile,
+  } = opts;
   if (!exportTo && !tag) {
     Task.error(
       `Neither ${chalk.white('--export-to')} or ${chalk.white('--tag')} was specified, either specify ${chalk.white('--export-to')} to export plugins to a directory or ${chalk.white('--tag')} to export plugins to a container image`,
@@ -32,6 +39,19 @@ export async function command(opts: OptionValues): Promise<void> {
       return;
     }
   }
+  const maketplaceInfo: Object[] = [];
+  if (marketplaceFile) {
+    if (!fs.existsSync(marketplaceFile)) {
+      Task.error(`Marketplace file ${marketplaceFile} does not exist`);
+      return;
+    }
+    const yamlDocuments = YAML.parseAllDocuments(
+      fs.readFileSync(marketplaceFile).toLocaleString(),
+    );
+    for (const document of yamlDocuments) {
+      maketplaceInfo.push(document.toJS());
+    }
+  }
   const workspacePackage = (await fs.readJson(
     paths.resolveTarget('package.json'),
   )) as PackageJson;
@@ -183,6 +203,7 @@ export async function command(opts: OptionValues): Promise<void> {
         );
       }
     }
+
     // Write the plugin registry metadata
     const metadataFile = path.join(tmpDir, 'index.json');
     Task.log(`Writing plugin registry metadata to '${metadataFile}'`);
@@ -200,12 +221,29 @@ export async function command(opts: OptionValues): Promise<void> {
         fs.copySync(source, destination, { recursive: true, overwrite: true });
       });
     } else {
+      // collect flags for the container build command
+      const flags = [
+        `--annotation io.backstage.dynamic-packages='${Buffer.from(JSON.stringify(pluginRegistryMetadata)).toString('base64')}'`,
+      ];
+
+      for (const pluginInfo of maketplaceInfo) {
+        const base64pluginInfo = Buffer.from(
+          JSON.stringify(pluginInfo),
+        ).toString('base64');
+        const pluginName = (pluginInfo as { metadata: { name: string } })
+          .metadata.name;
+        flags.push(
+          `--annotation io.backstage.marketplace/${pluginName}='${base64pluginInfo}'`,
+        );
+      }
       // run the command to generate the image
       Task.log(`Creating image using ${containerTool}`);
       await Task.forCommand(
         `echo "from scratch
 COPY . .
-" | ${containerTool} build --annotation com.redhat.rhdh.plugins='${JSON.stringify(pluginRegistryMetadata)}' -t '${tag}' -f - .
+" | ${containerTool} build \
+  ${flags.join(' ')} \
+  -t '${tag}' -f - .
     `,
         { cwd: tmpDir },
       );