@firestartr/cli 1.53.0-snapshot-13 → 1.54.0-snapshot-0

package/build/index.js

@@ -359560,6 +359560,7 @@ var ajv_default = /*#__PURE__*/__nccwpck_require__.n(dist_ajv);
 
 
 
+
 function validate_validate(featurePath) {
     __validateDirStructure(featurePath);
     const configData = __validateFeatureConfig(featurePath);
@@ -359574,6 +359575,17 @@ function __validateDirStructure(featurePath) {
     if (!isFile(external_path_.join(featurePath, 'config.yaml'))) {
         throw `Feature: ${featurePath}/config.yaml not found or not a file`;
     }
+    if (!isDirectory(external_path_.join(featurePath, 'templates/docs'))) {
+        throw `Feature: ${featurePath}templates/docs not a directory`;
+    }
+    if (!__validateDocsHasReadmes(featurePath)) {
+        throw `Feature: ${featurePath}: should have at least one .md file in the templates/docs`;
+    }
+}
+function __validateDocsHasReadmes(featurePath) {
+    const dirEntries = external_fs_default().readdirSync(external_path_.join(featurePath, 'templates/docs'));
+    return (dirEntries.some((entryFile) => !isDirectory(external_path_.join(featurePath, '/templates/docs', entryFile)) &&
+        entryFile.endsWith('.md')) !== undefined);
 }
 function __validateFeatureConfig(featurePath) {
     try {
@@ -360629,6 +360641,7 @@ function buildExpectedOutput(config, renderDir) {
         localPath: external_node_path_.join(renderDir, f.dest),
         repoPath: f.dest,
         userManaged: f.user_managed,
+        targetBranch: f.target_branch ?? '',
     }));
     return {
         files,
@@ -371256,6 +371269,7 @@ async function* markedToDeletion(item, op, handler) {
     // here we store the current callbacks that
     // are being used (synth|tf-apply...)
     let checkRunCtl;
+    let error = false;
     try {
         void cleanTerraformState();
         const type = 'DELETING';
@@ -371330,13 +371344,7 @@ async function* markedToDeletion(item, op, handler) {
         void handler.success();
     }
     catch (e) {
-        yield {
-            item,
-            reason: op,
-            type: 'ERROR',
-            status: 'True',
-            message: DESTROY_DEFAULT_ERROR_MESSAGE,
-        };
+        error = true;
         // if there is a current checkRun working
         // we close it with an error
         if (checkRunCtl)
@@ -371344,6 +371352,17 @@ async function* markedToDeletion(item, op, handler) {
         await handler.writeTerraformOutputInTfResult(item, e);
         void handler.error();
     }
+    finally {
+        if (error) {
+            yield {
+                item,
+                reason: op,
+                type: 'ERROR',
+                status: 'True',
+                message: DESTROY_DEFAULT_ERROR_MESSAGE,
+            };
+        }
+    }
 }
 async function* nothing(item, op, handler) {
     yield {
@@ -371363,6 +371382,7 @@ async function* doApply(item, op, handler) {
     // here we store the current callbacks that
     // are being used (synth|tf-apply...)
     let checkRunCtl;
+    let error = false;
     try {
         cleanTerraformState();
         yield {
@@ -371469,43 +371489,48 @@ async function* doApply(item, op, handler) {
         handler.success();
     }
     catch (e) {
-        let error;
+        error = true;
+        let errorMsg;
         if (typeof e === 'object' && 'output' in e) {
-            error = e.output;
+            errorMsg = e.output;
         }
         else {
-            error = e;
+            errorMsg = e;
         }
-        await tryPublishApply(item, error, item.kind);
+        await tryPublishApply(item, errorMsg, item.kind);
         // if there is a current checkRun working
         // we close it with an error
         if (checkRunCtl)
-            checkRunCtl.fnOnError(error);
-        operator_src_logger.error(`Error applying item ${item.metadata.name}: ${error}`);
-        yield {
-            item,
-            reason: op,
-            type: 'ERROR',
-            status: 'True',
-            message: APPLY_DEFAULT_ERROR_MESSAGE,
-        };
-        yield {
-            item,
-            reason: op,
-            type: 'PROVISIONED',
-            status: 'False',
-            message: APPLY_DEFAULT_ERROR_MESSAGE,
-        };
-        yield {
-            item,
-            reason: op,
-            type: 'PROVISIONING',
-            status: 'False',
-            message: APPLY_DEFAULT_ERROR_MESSAGE,
-        };
+            checkRunCtl.fnOnError(errorMsg);
+        operator_src_logger.error(`Error applying item ${item.metadata.name}: ${errorMsg}`);
         handler.error();
+        if (errorMsg) {
+            await handler.writeTerraformOutputInTfResult(item, errorMsg);
+        }
+    }
+    finally {
         if (error) {
-            await handler.writeTerraformOutputInTfResult(item, error);
+            yield {
+                item,
+                reason: op,
+                type: 'ERROR',
+                status: 'True',
+                message: APPLY_DEFAULT_ERROR_MESSAGE,
+            };
+            yield {
+                item,
+                reason: op,
+                type: 'PROVISIONED',
+                status: 'False',
+                message: APPLY_DEFAULT_ERROR_MESSAGE,
+            };
+            yield {
+                item,
+                reason: op,
+                type: 'PROVISIONING',
+                status: 'False',
+                message: APPLY_DEFAULT_ERROR_MESSAGE,
+            };
         }
     }
 }
@@ -372598,6 +372623,7 @@ async function* process_operation_observe(item, op, handler) {
     }
 }
 async function* doPlanJSONFormat(item, op, handler) {
+    let error = false;
     try {
         yield {
             item,
@@ -372683,36 +372709,9 @@ async function* doPlanJSONFormat(item, op, handler) {
         }
     }
     catch (e) {
+        error = true;
         console.error(e);
         operator_src_logger.error(`The Terraform processor encountered an error while observing the plan for item '${item.kind}/${item.metadata.name}': '${e}'.`);
-        yield {
-            item,
-            reason: op,
-            type: 'PROVISIONED',
-            status: 'False',
-            message: PLAN_DEFAULT_ERROR_MESSAGE,
-        };
-        yield {
-            item,
-            reason: op,
-            type: 'PLANNING',
-            status: 'False',
-            message: PLAN_DEFAULT_ERROR_MESSAGE,
-        };
-        yield {
-            item,
-            reason: op,
-            type: 'OUT_OF_SYNC',
-            status: 'False',
-            message: PLAN_DEFAULT_ERROR_MESSAGE,
-        };
-        yield {
-            item,
-            reason: op,
-            type: 'ERROR',
-            status: 'True',
-            message: PLAN_DEFAULT_ERROR_MESSAGE,
-        };
         const summaryText = tryCreateErrorSummary('Terraform Plan failed', e);
         if (item.metadata.annotations['firestartr.dev/last-state-pr'] || false) {
             await addPlanStatusCheck(item.metadata.annotations['firestartr.dev/last-state-pr'], summaryText, 'completed', true);
@@ -372722,6 +372721,38 @@ async function* doPlanJSONFormat(item, op, handler) {
             await handler.writeTerraformOutputInTfResult(item, e);
         }
     }
+    finally {
+        if (error) {
+            yield {
+                item,
+                reason: op,
+                type: 'PROVISIONED',
+                status: 'False',
+                message: PLAN_DEFAULT_ERROR_MESSAGE,
+            };
+            yield {
+                item,
+                reason: op,
+                type: 'PLANNING',
+                status: 'False',
+                message: PLAN_DEFAULT_ERROR_MESSAGE,
+            };
+            yield {
+                item,
+                reason: op,
+                type: 'OUT_OF_SYNC',
+                status: 'False',
+                message: PLAN_DEFAULT_ERROR_MESSAGE,
+            };
+            yield {
+                item,
+                reason: op,
+                type: 'ERROR',
+                status: 'True',
+                message: PLAN_DEFAULT_ERROR_MESSAGE,
+            };
+        }
+    }
 }
 async function* process_operation_created(item, op, handler) {
     for await (const transition of process_operation_doApply(item, op, handler)) {
@@ -372797,6 +372828,7 @@ async function* process_operation_sync(item, op, handler, syncPolicy, generalPol
     };
 }
 async function* process_operation_markedToDeletion(item, op, handler) {
+    let error = false;
     try {
         const type = 'DELETING';
         yield {
@@ -372877,19 +372909,24 @@ async function* process_operation_markedToDeletion(item, op, handler) {
         void handler.success();
     }
     catch (e) {
-        yield {
-            item,
-            reason: op,
-            type: 'ERROR',
-            status: 'True',
-            message: DESTROY_DEFAULT_ERROR_MESSAGE,
-        };
+        error = true;
         await handler.writeTerraformOutputInTfResult(item, e);
         if (item.metadata.annotations['firestartr.dev/last-state-pr'] || false) {
             await addDestroyCommitStatus(item, 'failure', 'Destroy operation failed', `Terraform Destroy ${item.metadata.name}`);
         }
         void handler.error();
     }
+    finally {
+        if (error) {
+            yield {
+                item,
+                reason: op,
+                type: 'ERROR',
+                status: 'True',
+                message: DESTROY_DEFAULT_ERROR_MESSAGE,
+            };
+        }
+    }
 }
 async function* process_operation_nothing(item, op, handler) {
     yield {
@@ -372908,6 +372945,7 @@ async function* process_operation_nothing(item, op, handler) {
  */
 async function* process_operation_doApply(item, op, handler) {
     const checkRunCtl = await TFCheckRun('apply', item);
+    let error = false;
     try {
         yield {
             item,
@@ -372991,36 +373029,41 @@ async function* process_operation_doApply(item, op, handler) {
         handler.success();
     }
     catch (e) {
+        error = true;
         checkRunCtl.fnOnError(e);
         console.error(e);
         await tryPublishApply(item, e, 'TFWorkspace');
         operator_src_logger.error(`The Terraform processor encountered an error during operation '${op}' for item '${item.kind}/${item.metadata.name}': '${e}'.`);
-        yield {
-            item,
-            reason: op,
-            type: 'ERROR',
-            status: 'True',
-            message: APPLY_DEFAULT_ERROR_MESSAGE,
-        };
-        yield {
-            item,
-            reason: op,
-            type: 'PROVISIONED',
-            status: 'False',
-            message: APPLY_DEFAULT_ERROR_MESSAGE,
-        };
-        yield {
-            item,
-            reason: op,
-            type: 'PROVISIONING',
-            status: 'False',
-            message: APPLY_DEFAULT_ERROR_MESSAGE,
-        };
         handler.error();
         if (e) {
             await handler.writeTerraformOutputInTfResult(item, e);
         }
     }
+    finally {
+        if (error) {
+            yield {
+                item,
+                reason: op,
+                type: 'ERROR',
+                status: 'True',
+                message: APPLY_DEFAULT_ERROR_MESSAGE,
+            };
+            yield {
+                item,
+                reason: op,
+                type: 'PROVISIONED',
+                status: 'False',
+                message: APPLY_DEFAULT_ERROR_MESSAGE,
+            };
+            yield {
+                item,
+                reason: op,
+                type: 'PROVISIONING',
+                status: 'False',
+                message: APPLY_DEFAULT_ERROR_MESSAGE,
+            };
+        }
+    }
 }
 async function* errorPolicyNotAllowsOp(item, op, handler, msg) {
     const reason = 'POLICY CONFLICT';
@@ -373422,6 +373465,7 @@ async function* processOperationPlan_plan(item, op, handler, format = 'plain-tex
     }
 }
 async function* doPlanPlainTextFormat(item, op, handler, action) {
+    let error = false;
     try {
         yield {
             item,
@@ -373481,32 +373525,12 @@ async function* doPlanPlainTextFormat(item, op, handler, action) {
         }
     }
     catch (e) {
+        error = true;
         const { prNumber, repo, org } = extractPrInfo(item, 'firestartr.dev/pull-request-plan');
         await publishPlan(item, JSON.stringify(e), prNumber, repo, org);
         operator_src_logger.error('TFWORKSPACE_PROCESSOR_PLAN_OBSERVING_ERROR', {
             metadata: { item, error: e },
         });
-        yield {
-            item,
-            reason: op,
-            type: 'PROVISIONED',
-            status: 'False',
-            message: PLAN_DEFAULT_ERROR_MESSAGE,
-        };
-        yield {
-            item,
-            reason: op,
-            type: 'PLANNING',
-            status: 'False',
-            message: PLAN_DEFAULT_ERROR_MESSAGE,
-        };
-        yield {
-            item,
-            reason: op,
-            type: 'ERROR',
-            status: 'True',
-            message: PLAN_DEFAULT_ERROR_MESSAGE,
-        };
         const summaryText = tryCreateErrorSummary('Terraform Plan failed', e);
         if (item.metadata.annotations['firestartr.dev/last-state-pr'] || false) {
             await addPlanStatusCheck(item.metadata.annotations['firestartr.dev/last-state-pr'], summaryText, 'completed', true);
@@ -373516,8 +373540,34 @@ async function* doPlanPlainTextFormat(item, op, handler, action) {
             await handler.writeTerraformOutputInTfResult(item, e);
         }
     }
+    finally {
+        if (error) {
+            yield {
+                item,
+                reason: op,
+                type: 'PROVISIONED',
+                status: 'False',
+                message: PLAN_DEFAULT_ERROR_MESSAGE,
+            };
+            yield {
+                item,
+                reason: op,
+                type: 'PLANNING',
+                status: 'False',
+                message: PLAN_DEFAULT_ERROR_MESSAGE,
+            };
+            yield {
+                item,
+                reason: op,
+                type: 'ERROR',
+                status: 'True',
+                message: PLAN_DEFAULT_ERROR_MESSAGE,
+            };
+        }
+    }
 }
 async function* processOperationPlan_doPlanJSONFormat(item, op, handler, action) {
+    let error = false;
     try {
         yield {
             item,
@@ -373600,43 +373650,48 @@ async function* processOperationPlan_doPlanJSONFormat(item, op, handler, action)
         }
     }
     catch (e) {
+        error = true;
         console.error(e);
         operator_src_logger.error('TFWORKSPACE_PROCESSOR_PLAN_DO_PLAN_ERROR', {
             metadata: { item, error: e },
         });
-        yield {
-            item,
-            reason: op,
-            type: 'PROVISIONED',
-            status: 'False',
-            message: PLAN_DEFAULT_ERROR_MESSAGE,
-        };
-        yield {
-            item,
-            reason: op,
-            type: 'PLANNING',
-            status: 'False',
-            message: PLAN_DEFAULT_ERROR_MESSAGE,
-        };
-        yield {
-            item,
-            reason: op,
-            type: 'OUT_OF_SYNC',
-            status: 'False',
-            message: PLAN_DEFAULT_ERROR_MESSAGE,
-        };
-        yield {
-            item,
-            reason: op,
-            type: 'ERROR',
-            status: 'True',
-            message: PLAN_DEFAULT_ERROR_MESSAGE,
-        };
         void handler.error();
         if (e) {
             await handler.writeTerraformOutputInTfResult(item, e);
         }
     }
+    finally {
+        if (error) {
+            yield {
+                item,
+                reason: op,
+                type: 'PROVISIONED',
+                status: 'False',
+                message: PLAN_DEFAULT_ERROR_MESSAGE,
+            };
+            yield {
+                item,
+                reason: op,
+                type: 'PLANNING',
+                status: 'False',
+                message: PLAN_DEFAULT_ERROR_MESSAGE,
+            };
+            yield {
+                item,
+                reason: op,
+                type: 'OUT_OF_SYNC',
+                status: 'False',
+                message: PLAN_DEFAULT_ERROR_MESSAGE,
+            };
+            yield {
+                item,
+                reason: op,
+                type: 'ERROR',
+                status: 'True',
+                message: PLAN_DEFAULT_ERROR_MESSAGE,
+            };
+        }
+    }
 }
 /**
  * @description Adapts the CR to the format expected by the terraform provisioner

package/build/packages/features_renderer/src/auxiliar.d.ts

@@ -5,6 +5,7 @@ export interface ConfigFile {
     dest: string;
     src: string;
     user_managed: boolean;
+    target_branch: string;
 }
 export interface FeatureConfig {
     files?: ConfigFile[];
@@ -14,6 +15,7 @@ export interface ExpectedFile {
     localPath: string;
     repoPath: string;
     userManaged: boolean;
+    targetBranch: string;
 }
 export interface ExpectedOutput {
     files: ExpectedFile[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firestartr/cli",
-  "version": "1.53.0-snapshot-13",
+  "version": "1.54.0-snapshot-0",
   "private": false,
   "description": "Commandline tool",
   "main": "build/main.js",