@storm-software/k8s-tools 0.28.1 → 0.29.0

package/CHANGELOG.md

@@ -2,6 +2,53 @@
 
 # Changelog for Storm Ops - K8s Tools
 
+## [0.29.0](https://github.com/storm-software/storm-ops/releases/tag/k8s-tools%400.29.0) (2025-05-06)
+
+### Features
+
+- **workspace-tools:** Update the release executor to replace workspace
+  configurations
+  ([7d2aa456c](https://github.com/storm-software/storm-ops/commit/7d2aa456c))
+
+### Miscellaneous
+
+- **monorepo:** Update the workspace dependency links
+  ([a2b0947a3](https://github.com/storm-software/storm-ops/commit/a2b0947a3))
+- **monorepo:** Regenerate README markdown files
+  ([96f241a4d](https://github.com/storm-software/storm-ops/commit/96f241a4d))
+- **monorepo:** Regenerate README markdown files
+  ([17bbe7e16](https://github.com/storm-software/storm-ops/commit/17bbe7e16))
+
+### Updated Dependencies
+
+- Updated workspace-tools to 1.271.0
+- Updated workspace-tools to 1.271.0
+- Updated config-tools to 1.167.0
+- Updated config-tools to 1.167.0
+- Updated config to 1.117.0
+- Updated config to 1.117.0
+
+## [0.28.2](https://github.com/storm-software/storm-ops/releases/tag/k8s-tools%400.28.2) (2025-05-06)
+
+### Bug Fixes
+
+- **workspace-tools:** Resolve issue with import path in executor
+  ([ddad2fdc8](https://github.com/storm-software/storm-ops/commit/ddad2fdc8))
+
+### Miscellaneous
+
+- **monorepo:** Regenerate README markdown files
+  ([7e0751c3d](https://github.com/storm-software/storm-ops/commit/7e0751c3d))
+
+### Updated Dependencies
+
+- Updated workspace-tools to 1.270.2
+- Updated workspace-tools to 1.270.2
+- Updated config-tools to 1.166.2
+- Updated config-tools to 1.166.2
+- Updated config to 1.116.2
+- Updated config to 1.116.2
+
 ## [0.28.1](https://github.com/storm-software/storm-ops/releases/tag/k8s-tools%400.28.1) (2025-05-06)
 
 ### Bug Fixes

package/README.md

@@ -21,7 +21,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
 
 <h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br />
 
-[![Version](https://img.shields.io/badge/version-0.27.2-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
+[![Version](https://img.shields.io/badge/version-0.28.2-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
 
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storm-software/k8s-tools",
-  "version": "0.28.1",
+  "version": "0.29.0",
   "description": "Tools for managing Kubernetes (k8s) infrastructure within a Nx workspace.",
   "repository": {
     "type": "github",
@@ -31,28 +31,16 @@
         "types": "./dist/index.d.mts",
         "default": "./dist/index.mjs"
       },
-      "require": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      },
-      "default": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      }
+      "require": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
+      "default": { "types": "./dist/index.d.ts", "default": "./dist/index.js" }
     },
     "./index": {
       "import": {
         "types": "./dist/index.d.mts",
         "default": "./dist/index.mjs"
       },
-      "require": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      },
-      "default": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      }
+      "require": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
+      "default": { "types": "./dist/index.d.ts", "default": "./dist/index.js" }
     },
     "./executors": {
       "import": {
@@ -145,26 +133,16 @@
     "tsup": "8.4.0"
   },
   "peerDependenciesMeta": {
-    "@nx-tools/container-metadata": {
-      "optional": false
-    },
-    "@nx-tools/nx-container": {
-      "optional": false
-    },
-    "@nx/devkit": {
-      "optional": false
-    },
-    "@nx/workspace": {
-      "optional": false
-    },
-    "nx": {
-      "optional": false
-    }
+    "@nx-tools/container-metadata": { "optional": false },
+    "@nx-tools/nx-container": { "optional": false },
+    "@nx/devkit": { "optional": false },
+    "@nx/workspace": { "optional": false },
+    "nx": { "optional": false }
   },
   "dependencies": {
-    "@storm-software/config": "1.116.1",
-    "@storm-software/config-tools": "1.166.1",
-    "@storm-software/workspace-tools": "1.270.1",
+    "@storm-software/config": "^1.117.1",
+    "@storm-software/config-tools": "^1.167.1",
+    "@storm-software/workspace-tools": "^1.271.1",
     "js-yaml": "^4.1.0"
   },
   "devDependencies": {
@@ -179,9 +157,7 @@
     "typescript": "^5.8.3",
     "untyped": "^1.5.2"
   },
-  "publishConfig": {
-    "access": "public"
-  },
+  "publishConfig": { "access": "public" },
   "executors": "./executors.json",
   "generators": "./generators.json"
-}
+}

package/.eslintrc.json

@@ -1,35 +0,0 @@
-{
-  "extends": ["../../.eslintrc.json"],
-  "ignorePatterns": ["!**/*"],
-  "overrides": [
-    {
-      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
-      "parserOptions": {
-        "project": ["packages/k8s-tools/tsconfig.*?.json"]
-      },
-      "rules": {}
-    },
-    {
-      "files": ["*.ts", "*.tsx"],
-      "rules": {}
-    },
-    {
-      "files": ["*.js", "*.jsx"],
-      "rules": {}
-    },
-    {
-      "files": ["*.json"],
-      "parser": "jsonc-eslint-parser",
-      "rules": {
-        "@nx/dependency-checks": "error"
-      }
-    },
-    {
-      "files": ["./package.json", "./executors.json", "./generators.json"],
-      "parser": "jsonc-eslint-parser",
-      "rules": {
-        "@nx/nx-plugin-checks": "error"
-      }
-    }
-  ]
-}

package/executors.ts

@@ -1,4 +0,0 @@
-export * from "./src/executors/container-publish/executor";
-export { type ContainerPublishExecutorSchema } from "./src/executors/container-publish/schema.d";
-export * from "./src/executors/helm-package/executor";
-export { type HelmPackageExecutorSchema } from "./src/executors/helm-package/schema.d";

package/generators.ts

@@ -1,4 +0,0 @@
-export * from "./src/generators/helm-chart/generator";
-export { type HelmChartGeneratorSchema } from "./src/generators/helm-chart/schema.d";
-export * from "./src/generators/helm-dependency/generator";
-export { type HelmDependencyGeneratorSchema } from "./src/generators/helm-dependency/schema.d";

package/index.ts

@@ -1,5 +0,0 @@
-export * from "./executors";
-export * from "./generators";
-export * from "./src/plugins";
-export * from "./src/types";
-export * from "./src/utils";

package/project.json

@@ -1,61 +0,0 @@
-{
-  "name": "k8s-tools",
-  "$schema": "../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "packages/k8s-tools/src",
-  "projectType": "library",
-  "implicitDependencies": [
-    "workspace-tools",
-    "untyped",
-    "config-tools",
-    "config"
-  ],
-  "targets": {
-    "build-untyped": {
-      "executor": "nx:run-commands",
-      "dependsOn": ["clean", "^build"],
-      "inputs": [
-        "{projectRoot}/src/**/untyped.ts",
-        "{projectRoot}/src/**/*.untyped.ts"
-      ],
-      "outputs": [
-        "{projectRoot}/src/**/schema.d.ts",
-        "{projectRoot}/src/**/*.schema.d.ts",
-        "{projectRoot}/src/**/schema.md",
-        "{projectRoot}/src/**/*.schema.md",
-        "{projectRoot}/src/**/schema.json",
-        "{projectRoot}/src/**/*.schema.json"
-      ],
-      "options": {
-        "commands": [
-          "node dist/packages/untyped/bin/untyped.cjs generate --entry=\"packages/k8s-tools/**/{untyped.ts,*.untyped.ts}\" "
-        ]
-      }
-    },
-    "build-base": {
-      "executor": "nx:run-commands",
-      "dependsOn": ["build-untyped", "clean", "^build"],
-      "options": {
-        "command": "tsup-node --config=tsup.config.ts",
-        "cwd": "{projectRoot}"
-      }
-    },
-    "build": {
-      "executor": "nx:run-commands",
-      "dependsOn": ["build-base", "build-untyped"],
-      "options": {
-        "commands": [
-          "pnpm copyfiles LICENSE dist/packages/k8s-tools",
-          "pnpm copyfiles --up=2 ./packages/k8s-tools/*.md ./packages/k8s-tools/executors.json ./packages/k8s-tools/generators.json ./packages/k8s-tools/package.json dist/packages/k8s-tools",
-          "pnpm copyfiles --up=3 \"./packages/k8s-tools/dist/**/*\" dist/packages/k8s-tools/dist",
-          "pnpm copyfiles --up=3 \"./packages/k8s-tools/src/**/*schema.d.ts\" dist/packages/k8s-tools/dist/src",
-          "pnpm copyfiles --up=3 \"./packages/k8s-tools/src/**/*schema.json\" dist/packages/k8s-tools/dist/src",
-          "pnpm copyfiles --up=3 \"./packages/k8s-tools/src/**/*.md\" dist/packages/k8s-tools/docs/api",
-          "pnpm copyfiles --up=4 \"./packages/k8s-tools/src/generators/*/files/**/*\" dist/packages/k8s-tools/dist/src/generators"
-        ]
-      }
-    },
-    "nx-release-publish": {
-      "executor": "@storm-software/workspace-tools:npm-publish"
-    }
-  }
-}

package/src/executors/container-publish/executor.spec.ts

@@ -1,18 +0,0 @@
-import { ExecutorContext } from "@nx/devkit";
-
-import executor from "./executor";
-import { ContainerPublishExecutorSchema } from "./schema";
-
-const options: ContainerPublishExecutorSchema = {};
-const context: ExecutorContext = {
-  root: "",
-  cwd: process.cwd(),
-  isVerbose: false,
-};
-
-describe("ContainerPublish Executor", () => {
-  it("can run", async () => {
-    const output = await executor(options, context);
-    expect(output.success).toBe(true);
-  });
-});

package/src/executors/container-publish/executor.ts

@@ -1,216 +0,0 @@
-import {
-  parseTargetString,
-  runExecutor,
-  type ExecutorContext
-} from "@nx/devkit";
-import { StormWorkspaceConfig } from "@storm-software/config";
-import {
-  applyWorkspaceTokens,
-  findWorkspaceRoot,
-  getConfig,
-  type BaseTokenizerOptions
-} from "@storm-software/config-tools";
-import { applyWorkspaceExecutorTokens } from "@storm-software/workspace-tools/utils/apply-workspace-tokens";
-import { getPackageInfo } from "@storm-software/workspace-tools/utils/package-helpers";
-import { CargoToml } from "@storm-software/workspace-tools/utils/toml";
-import https from "node:https";
-import type { ContainerPublishExecutorSchema } from "./schema.d";
-
-export default async function* publishExecutor(
-  options: ContainerPublishExecutorSchema,
-  context: ExecutorContext
-) {
-  /**
-   * We need to check both the env var and the option because the executor may have been triggered
-   * indirectly via dependsOn, in which case the env var will be set, but the option will not.
-   */
-  const isDryRun = process.env.NX_DRY_RUN === "true" || options.dryRun || false;
-
-  if (!context.projectName) {
-    throw new Error("The executor requires a projectName.");
-  }
-
-  console.info(
-    `🚀  Running Storm Container Registry Publish executor on the ${context.projectName} crate`
-  );
-
-  const workspaceRoot = findWorkspaceRoot();
-  const config = await getConfig(workspaceRoot);
-
-  const projectConfig =
-    context.projectsConfigurations?.projects[context.projectName];
-  if (!projectConfig) {
-    throw new Error(
-      `The executor requires a valid projectsConfiguration - No configuration found for project ${context.projectName}`
-    );
-  }
-
-  const projectRoot = projectConfig?.root ?? workspaceRoot;
-  const sourceRoot = projectConfig?.sourceRoot ?? workspaceRoot;
-  const projectName = projectConfig?.name ?? context.projectName;
-  config.workspaceRoot = workspaceRoot;
-
-  const tokenized = (await applyWorkspaceTokens(
-    options,
-    {
-      config,
-      workspaceRoot,
-      projectRoot,
-      sourceRoot,
-      projectName,
-      ...projectConfig
-    } as BaseTokenizerOptions,
-    applyWorkspaceExecutorTokens
-  )) as ContainerPublishExecutorSchema;
-
-  tokenized.engine ??= "docker";
-  tokenized.registry ??= config.registry.container;
-
-  try {
-    if (isDryRun) {
-      console.log(
-        `Would publish to ${tokenized.registry}, but [dry-run] was set`
-      );
-    } else {
-      console.log(`Published to ${tokenized.registry}`);
-
-      const packageManager = getPackageInfo(projectConfig);
-      if (packageManager) {
-        tokenized["build-args"] ??= [
-          "ENVIRONMENT=production",
-          "DEBUG_IMAGE=false"
-        ];
-        tokenized["labels"] ??= [];
-
-        let version = "";
-        if (process.env.TAG) {
-          version = process.env.TAG;
-        } else {
-          if (packageManager.type === "Cargo.toml") {
-            version = (packageManager.content as CargoToml).package.version;
-          } else if (packageManager.type === "package.json") {
-            version = packageManager.content.version;
-          }
-        }
-
-        tokenized["build-args"].push(`RELEASE=${version}`);
-        tokenized["labels"].push(`org.opencontainers.image.version=${version}`);
-
-        const tags = await getRegistryVersion(projectName, config);
-        if (tags.length === 0) {
-          tokenized["labels"].push(
-            `org.opencontainers.image.created=${new Date().toISOString()}`
-          );
-        } else if (tags.includes(version)) {
-          console.warn(
-            `Skipped package "${projectName}" because v${version} already exists in ${tokenized.registry}`
-          );
-          return {
-            success: true
-          };
-        }
-      } else {
-        console.warn(
-          `No package manager found for project "${projectName}" - Skipping container publishing`
-        );
-        return {
-          success: true
-        };
-      }
-
-      const { project, target, configuration } = parseTargetString(
-        "container",
-        context
-      );
-      for await (const output of await runExecutor<{
-        success: boolean;
-        baseUrl?: string;
-      }>({ project, target, configuration }, tokenized, context)) {
-        if (!output.success) {
-          throw new Error("Could not compile application files");
-        }
-        yield;
-      }
-    }
-
-    return {
-      success: true
-    };
-  } catch (error: any) {
-    console.error(`Failed to publish to ${tokenized.registry}`);
-    console.error(error);
-    console.log("");
-
-    return {
-      success: false
-    };
-  }
-}
-
-export const getRegistryVersion = (
-  name: string,
-  config: StormWorkspaceConfig
-): Promise<string[]> => {
-  if (!name) {
-    throw new Error(
-      "The `getRegistryVersion` function requires a container name."
-    );
-  }
-
-  try {
-    const tagsApiUrl = `${config.registry.container}/v2/namespaces/${encodeURIComponent(config.namespace ? config.namespace : "storm-software")}/repositories/${encodeURIComponent(
-      name.replace(`${config.namespace}-`, "")
-    )}/tags`;
-    console.log(`Checking for existing version at ${tagsApiUrl}`);
-
-    return new Promise(
-      (resolve: (value: string[]) => void, reject: (error: any) => void) =>
-        https
-          .get(tagsApiUrl, res => {
-            if (res.statusCode === 404) {
-              console.log(`No existing version found at ${tagsApiUrl}`);
-              return resolve([] as string[]);
-            }
-
-            res.on("data", data => {
-              if (data) {
-                console.log(
-                  `Existing versions found at ${tagsApiUrl} - ${data}`
-                );
-                const json = JSON.parse(data.toString());
-                return resolve(
-                  json.results
-                    .filter(
-                      (result: { status: string; name: string }) =>
-                        result.status === "active" &&
-                        result.name &&
-                        result.name !== "latest"
-                    )
-                    .map((result: { name: string }) => result.name)
-                );
-              }
-
-              return reject(
-                new Error(
-                  "No data returned from container registry, expected a 404 if no tags exist"
-                )
-              );
-            });
-          })
-          .on("error", e => {
-            throw e;
-          })
-    );
-  } catch (error) {
-    console.error(`Failed to get version from ${config.registry.container}`);
-    console.error(error);
-    console.log("");
-
-    throw new Error(
-      `Could not get version from container registry - ${config.registry.container}`,
-      {
-        cause: error
-      }
-    );
-  }
-};

package/src/executors/helm-package/executor.ts

@@ -1,71 +0,0 @@
-import type { ExecutorContext, PromiseExecutor } from "@nx/devkit";
-import type { StormWorkspaceConfig } from "@storm-software/config";
-import { writeWarning } from "@storm-software/config-tools/logger/console";
-import { withRunExecutor } from "@storm-software/workspace-tools/base/base-executor";
-import { createHelmClient } from "../../utils/client";
-import { HelmPackageExecutorSchema } from "./schema";
-
-export async function serveExecutor(
-  options: HelmPackageExecutorSchema,
-  context: ExecutorContext,
-  config?: StormWorkspaceConfig
-) {
-  if (
-    !context?.projectName ||
-    !context?.projectsConfigurations?.projects?.[context.projectName]?.root
-  ) {
-    throw new Error("Nx executor context was invalid");
-  }
-
-  const helm = createHelmClient();
-  if (options.dependencies?.repositories) {
-    for (const repository of options.dependencies.repositories) {
-      if (repository.name && repository.url) {
-        helm.addRepository(repository.name, repository.url);
-      } else {
-        throw new Error("Repository name and url are required");
-      }
-    }
-  }
-
-  if (options.dependencies?.update) {
-    helm.dependencyUpdate(options.chartFolder);
-  }
-
-  if (options.dependencies?.build) {
-    helm.dependencyBuild(options.chartFolder);
-  }
-
-  const chartPath = await helm.package({
-    chartFolder: options.chartFolder,
-    outputFolder: options.outputFolder
-  });
-
-  if (options.push && chartPath && options.remote) {
-    helm.push({
-      chartPath,
-      remote: options.remote
-    });
-  } else {
-    writeWarning(`Chart packaged at: ${chartPath}`, config);
-  }
-
-  return {
-    success: true
-  };
-}
-
-export default withRunExecutor<HelmPackageExecutorSchema>(
-  "Helm Chart Package executor",
-  serveExecutor,
-  {
-    skipReadingConfig: false,
-    hooks: {
-      applyDefaultOptions: (options: HelmPackageExecutorSchema) => {
-        options.port ??= 4500;
-
-        return options as HelmPackageExecutorSchema;
-      }
-    }
-  }
-) as PromiseExecutor<HelmPackageExecutorSchema>;

package/src/generators/helm-chart/files/chart/.helmignore

@@ -1,23 +0,0 @@
-# Patterns to ignore when building packages.
-# This supports shell glob matching, relative path matching, and
-# negation (prefixed with !). Only one pattern per line.
-.DS_Store
-# Common VCS dirs
-.git/
-.gitignore
-.bzr/
-.bzrignore
-.hg/
-.hgignore
-.svn/
-# Common backup files
-*.swp
-*.bak
-*.tmp
-*.orig
-*~
-# Various IDEs
-.project
-.idea/
-*.tmproj
-.vscode/

package/src/generators/helm-chart/generator.ts

@@ -1,69 +0,0 @@
-import {
-  formatFiles,
-  generateFiles,
-  readProjectConfiguration,
-  Tree,
-  updateProjectConfiguration
-} from "@nx/devkit";
-import { StormWorkspaceConfig } from "@storm-software/config";
-import { writeDebug } from "@storm-software/config-tools/logger/console";
-import { withRunGenerator } from "@storm-software/workspace-tools/base/base-generator";
-import { join } from "path";
-import type { HelmChartGeneratorSchema } from "./schema";
-
-export async function helmChartGeneratorFn(
-  tree: Tree,
-  options: HelmChartGeneratorSchema,
-  config?: StormWorkspaceConfig
-) {
-  writeDebug("📝  Preparing to write Helm Chart", config);
-
-  const project = readProjectConfiguration(tree, options.project);
-  if (project.targets?.["helm-package"]) {
-    throw new Error(
-      `Project ${options.project} already has a helm target. Please remove it before running this command.`
-    );
-  }
-
-  updateProjectConfiguration(tree, options.project, {
-    ...project,
-    targets: {
-      ...project.targets,
-      "helm-package": {
-        executor: "@storm-software/k8s-tools:helm-package",
-        outputs: ["{options.outputFolder}"],
-        options: {
-          chartFolder: `${project.root}/${options.chartFolder}`,
-          outputFolder: "{workspaceRoot}/dist/charts/{projectRoot}",
-          push: false,
-          remote: "oci://localhost:5000/helm-charts",
-          dependencies: {
-            update: true,
-            build: true,
-            repositories: []
-          }
-        }
-      }
-    }
-  });
-
-  generateFiles(
-    tree,
-    join(__dirname, "files", "chart"),
-    join(project.root, options.chartFolder ?? ""),
-    options
-  );
-
-  if (options.format) {
-    await formatFiles(tree);
-  }
-
-  return {
-    success: true
-  };
-}
-
-export default withRunGenerator<HelmChartGeneratorSchema>(
-  "Helm Chart",
-  helmChartGeneratorFn
-);