Add --skip-compose-validation to build command (#472)

* remove composeSafeKeys export and delete params.ts file

* remove file not existing

* implement skipComposeValidation

* add arg

Author: pablomendezroyo

src/commands/build/handler.ts

@@ -22,6 +22,7 @@ export async function buildHandler({
   all_variants: allVariants,
   variants_dir_name: variantsDirName = defaultVariantsDirName,
   variants,
+  skip_compose_validation: skipComposeValidation,
   // Global options
   dir = defaultDir,
   compose_file_name: composeFileName = defaultComposeFileName,
@@ -43,6 +44,7 @@ export async function buildHandler({
     requireGitData,
     deleteOldPins,
     variantsDirPath,
+    skipComposeValidation,
     packagesToBuildProps: getPackagesToBuildProps({
       allVariants: Boolean(allVariants),
       commaSeparatedVariants: variants,

src/commands/build/index.ts

@@ -53,6 +53,11 @@ export const build: CommandModule<CliGlobalOptions, BuildCommandOptions> = {
       alias: "variant",
       description: `Specify the package variants to build (only for packages that support it). Defined by comma-separated list of variant names. Example: "variant1,variant2"`,
       type: "string"
+    },
+    skip_compose_validation: {
+      alias: "skip-compose-validation",
+      description: `Skip the Dappnode compose validation step`,
+      type: "boolean"
     }
   },
 

src/commands/build/types.ts

@@ -12,6 +12,7 @@ export interface BuildCommandOptions extends CliGlobalOptions {
   variants_dir_name?: string;
   variants?: string;
   all_variants?: boolean;
+  skip_compose_validation?: boolean;
 }
 
 export interface VerbosityOptions {

src/commands/publish/handler.ts

@@ -27,6 +27,7 @@ export async function publishHandler({
   dappnode_team_preset: dappnode_team_preset,
   require_git_data: requireGitData,
   delete_old_pins: deleteOldPins,
+  skip_compose_validation: skipComposeValidation,
   // Global options
   dir = defaultDir,
   compose_file_name: composeFileName = defaultComposeFileName,
@@ -80,6 +81,7 @@ export async function publishHandler({
       githubRelease,
       verbosityOptions,
       variantsDirPath,
+      skipComposeValidation,
       packagesToBuildProps: getPackagesToBuildProps({
         allVariants: Boolean(allVariants),
         commaSeparatedVariants: variants,

src/commands/publish/index.ts

@@ -83,6 +83,11 @@ export const publish: CommandModule<CliGlobalOptions, PublishCommandOptions> = {
       alias: "variant",
       description: `Specify the package variants to build (only for packages that support it). Defined by comma-separated list of variant names. If not specified, all variants will be built. Example: "variant1,variant2"`,
       type: "string"
+    },
+    skip_compose_validation: {
+      alias: "skip-compose-validation",
+      description: `Skip the Dappnode compose validation step`,
+      type: "boolean"
     }
   },
 

src/commands/publish/types.ts

@@ -16,4 +16,5 @@ export interface PublishCommandOptions extends CliGlobalOptions {
   variants_dir_name?: string;
   variants?: string;
   all_variants?: boolean;
+  skip_compose_validation?: boolean;
 }

src/files/compose/index.ts

@@ -5,4 +5,3 @@ export { parseComposeUpstreamVersion } from "./parseComposeUpstreamVersion.js";
 export { readCompose } from "./readCompose.js";
 export { updateComposeImageTags } from "./updateComposeImageTags.js";
 export { writeCompose } from "./writeCompose.js";
-export { composeSafeKeys } from "./params.js";

src/files/compose/params.ts

@@ -1,8 +1,6 @@
 import { releaseFiles } from "@dappnode/types";
 import { ManifestFormat } from "./files/manifest/types.js";
 
-export * from "./files/compose/params.js";
-
 export class CliError extends Error {}
 export class YargsError extends Error {}
 

src/params.ts

@@ -11,27 +11,36 @@ import { getComposePath } from "../../files/index.js";
 import { CliError } from "../../params.js";
 
 export function getFileValidationTask({
-  packagesToBuildProps
+  packagesToBuildProps,
+  skipComposeValidation
 }: {
   packagesToBuildProps: PackageToBuildProps[];
+  skipComposeValidation?: boolean;
 }): ListrTask<ListrContextBuild> {
   return {
     title: `Validate files`,
-    task: async () => await validatePackageFiles({ packagesToBuildProps })
+    task: async () =>
+      await validatePackageFiles({
+        packagesToBuildProps,
+        skipComposeValidation
+      })
   };
 }
 
 async function validatePackageFiles({
-  packagesToBuildProps
+  packagesToBuildProps,
+  skipComposeValidation
 }: {
   packagesToBuildProps: PackageToBuildProps[];
+  skipComposeValidation?: boolean;
 }): Promise<void> {
   for (const pkgProps of packagesToBuildProps)
-    await validateVariantFiles(pkgProps);
+    await validateVariantFiles(pkgProps, skipComposeValidation);
 }
 
 async function validateVariantFiles(
-  pkgProps: PackageToBuildProps
+  pkgProps: PackageToBuildProps,
+  skipComposeValidation?: boolean
 ): Promise<void> {
   const {
     manifest,
@@ -57,7 +66,11 @@ async function validateVariantFiles(
   );
 
   // Validate compose file specifically for Dappnode requirements
-  validateDappnodeCompose(compose, manifest);
+  if (skipComposeValidation) {
+    console.log(`Skipping Dappnode compose validation for ${manifest.name}`);
+  } else {
+    validateDappnodeCompose(compose, manifest);
+  }
 
   // Validate notifications schema
   if (notifications) validateNotificationsSchema(notifications);