@storm-software/git-tools 2.123.16 → 2.124.0

package/dist/types.d.ts

@@ -2,7 +2,8 @@ import { ProjectGraph, ProjectsConfigurations } from '@nx/devkit';
 import { Variant } from '@storm-software/config/types';
 import { CommitEnumItemProps } from 'conventional-changelog-storm-software/types/commit-types';
 import { RuleConfigSeverity } from 'conventional-changelog-storm-software/types/commitlint';
-import { NxReleaseVersionConfiguration, NxReleaseChangelogConfiguration, NxReleaseGitConfiguration, NxReleaseConventionalCommitsConfiguration } from 'nx/src/config/nx-json';
+import { NxReleaseConfig } from 'nx/src/command-line/release/config/config';
+import { NxReleaseDockerConfiguration, NxReleaseVersionConfiguration, NxReleaseChangelogConfiguration, NxReleaseVersionPlansConfiguration, NxReleaseConfiguration } from 'nx/src/config/nx-json';
 
 type DeepPartial<T> = T extends object ? {
     [P in keyof T]?: DeepPartial<T[P]>;
@@ -72,7 +73,7 @@ interface CommitLintOutcome {
     /** All warnings, per rule, for the commit */
     warnings: CommitLintRuleOutcome[];
 }
-type ReleaseConfig = any & {
+type ReleaseOptions = any & {
     npm: boolean;
     github: boolean;
     githubOptions?: Record<string, unknown>;
@@ -111,124 +112,120 @@ interface ReadMeOptions {
     clean: boolean;
     prettier: boolean;
 }
-interface NxReleaseConfig {
+interface ReleaseGroupConfig {
     /**
-     * Shorthand for amending the projects which will be included in the implicit default release group (all projects by default).
-     * @note Only one of `projects` or `groups` can be specified, the cannot be used together.
+     * Whether to version and release projects within the group independently, or together in lock step ("fixed").
+     * If not set on the group, this will be informed by the projectsRelationship config at the top level.
      */
-    projects?: string[] | string;
+    projectsRelationship?: "fixed" | "independent";
     /**
-     * @note When no projects or groups are configured at all (the default), all projects in the workspace are treated as
-     * if they were in a release group together with a fixed relationship.
+     * Required list of one or more projects to include in the release group. Any single project can
+     * only be used in a maximum of one release group.
      */
-    groups?: Record<string, // group name
-    {
-        /**
-         * Whether to version and release projects within the group independently, or together in lock step ("fixed").
-         * If not set on the group, this will be informed by the projectsRelationship config at the top level.
-         */
-        projectsRelationship?: "fixed" | "independent";
-        /**
-         * Required list of one or more projects to include in the release group. Any single project can
-         * only be used in a maximum of one release group.
-         */
-        projects: string[] | string;
-        /**
-         * Optionally override version configuration for this group.
-         *
-         * NOTE: git configuration is not supported at the group level, only the root/command level
-         */
-        version?: NxReleaseVersionConfiguration;
+    projects: string[] | string;
+    /**
+     * Configure options to handle versioning docker projects for this group.
+     * Set to `true` to enable with default settings, or provide a configuration object for custom settings.
+     */
+    docker?: (NxReleaseDockerConfiguration & {
         /**
-         * Project changelogs are disabled by default.
-         *
-         * Here you can optionally override project changelog configuration for this group.
-         * Notes about boolean values:
-         *
-         * - true = enable project level changelogs using default configuration
-         * - false = explicitly disable project level changelogs
-         *
-         * NOTE: git configuration is not supported at the group level, only the root/command level
+         * A command to run after validation of nx release configuration, but before docker versioning begins.
+         * Used for preparing docker build artifacts. If --dry-run is passed, the command is still executed, but
+         * with the NX_DRY_RUN environment variable set to 'true'.
+         * It will run in addition to the global `preVersionCommand`
          */
-        changelog?: NxReleaseChangelogConfiguration | boolean;
+        groupPreVersionCommand?: string;
+    }) | true;
+    /**
+     * Optionally override version configuration for this group.
+     *
+     * NOTE: git configuration is not supported at the group level, only the root/command level
+     */
+    version?: NxReleaseVersionConfiguration & {
         /**
-         * Optionally override the git/release tag pattern to use for this group.
+         * A command to run after validation of nx release configuration, but before versioning begins.
+         * Used for preparing build artifacts. If --dry-run is passed, the command is still executed, but
+         * with the NX_DRY_RUN environment variable set to 'true'.
+         * It will run in addition to the global `preVersionCommand`
          */
-        releaseTagPattern?: string;
-    }>;
+        groupPreVersionCommand?: string;
+    };
     /**
-     * Configures the default value for all groups that don't explicitly state their own projectsRelationship.
+     * Project changelogs are disabled by default.
+     *
+     * Here you can optionally override project changelog configuration for this group.
+     * Notes about boolean values:
+     *
+     * - true = enable project level changelogs using default configuration
+     * - false = explicitly disable project level changelogs
      *
-     * By default, this is set to "fixed" which means all projects in the workspace will be versioned and
-     * released together in lock step.
+     * NOTE: git configuration is not supported at the group level, only the root/command level
      */
-    projectsRelationship?: "fixed" | "independent";
-    changelog?: {
+    changelog?: NxReleaseChangelogConfiguration | boolean;
+    /**
+     * Configuration for release tag generation and matching.
+     */
+    releaseTag?: {
         /**
-         * Enable or override configuration for git operations as part of the changelog subcommand
+         * The pattern to use for release tags. Supports interpolating {version}, {projectName}, and {releaseGroupName}.
          */
-        git?: NxReleaseGitConfiguration;
+        pattern?: string;
         /**
-         * Workspace changelog is enabled by default. Notes about boolean values:
+         * By default, we will try and resolve the latest match for the releaseTagPattern from the current branch,
+         * falling back to all branches if no match is found on the current branch.
          *
-         * - true = explicitly enable workspace changelog using default configuration
-         * - false = disable workspace changelog
+         * - Setting this to true will cause us to ALWAYS check all branches for the latest match.
+         * - Setting it to false will cause us to ONLY check the current branch for the latest match.
+         * - Setting it to an array of strings will cause us to check all branches WHEN the current branch matches one of the strings in the array. Glob patterns are supported.
          */
-        workspaceChangelog?: NxReleaseChangelogConfiguration | boolean;
+        checkAllBranchesWhen?: boolean | string[];
         /**
-         * Project changelogs are disabled by default. Notes about boolean values:
+         * By default, we will use semver when searching through the tags to find the latest matching tag.
          *
-         * - true = enable project level changelogs using default configuration
-         * - false = explicitly disable project level changelogs
+         * - Setting this to true will cause us to use semver to match the version
+         * - Setting this to false will cause us to not use semver to match the version allowing for non-semver versions
          */
-        projectChangelogs?: NxReleaseChangelogConfiguration | boolean;
-        /**
-         * Whether or not to automatically look up the first commit for the workspace (or package, if versioning independently)
-         * and use that as the starting point for changelog generation. If this is not enabled, changelog generation will fail
-         * if there is no previous matching git tag to use as a starting point.
-         */
-        automaticFromRef?: boolean;
-    };
-    /**
-     * If no version config is provided, we will assume that @nx/js:release-version
-     * is the desired generator implementation, allowing for terser config for the common case.
-     */
-    version?: NxReleaseVersionConfiguration & {
+        requireSemver?: boolean;
         /**
-         * Enable or override configuration for git operations as part of the version subcommand
+         * Controls how docker versions are used relative to semver versions when creating git tags and changelog entries.
+         *
+         * - true: Use only the docker version
+         * - false: Use only the semver version
+         * - 'both': Create tags and changelog entries for both docker and semver versions
+         *
+         * By default, this is set to true when docker configuration is present, and false otherwise.
          */
-        git?: NxReleaseGitConfiguration;
+        preferDockerVersion?: boolean | "both";
         /**
-         * A command to run after validation of nx release configuration, but before versioning begins.
-         * Used for preparing build artifacts. If --dry-run is passed, the command is still executed, but
-         * with the NX_DRY_RUN environment variable set to 'true'.
+         * When set to true and multiple tags match your configured pattern, the git tag matching logic will strictly prefer the tag which contain a semver preid which matches the one
+         * given to the nx release invocation.
+         *
+         * For example, let's say your pattern is "{projectName}@{version}" and you have the following tags for project "my-lib", which uses semver:
+         * - my-lib@1.2.4-beta.1
+         * - my-lib@1.2.4-alpha.1
+         * - my-lib@1.2.3
+         *
+         * If "strictPreid" is set to true and you run:
+         * - `nx release --preid beta`, the git tag "my-lib@1.2.4-beta.1" will be resolved.
+         * - `nx release --preid alpha`, the git tag "my-lib@1.2.4-alpha.1" will be resolved.
+         * - `nx release` (no preid), the git tag "my-lib@1.2.3" will be resolved.
+         *
+         * If "strictPreid" is set to false, the git tag "my-lib@1.2.4-beta.1" will always be resolved as the latest tag that matches the pattern,
+         * regardless of any preid which gets passed to nx release.
+         *
+         * NOTE: This feature was added in a minor version and is therefore set to false by default, but this may change in a future major version.
          */
-        preVersionCommand?: string;
+        strictPreid?: boolean;
     };
     /**
-     * Optionally override the git/release tag pattern to use. This field is the source of truth
-     * for changelog generation and release tagging, as well as for conventional commits parsing.
-     *
-     * It supports interpolating the version as {version} and (if releasing independently or forcing
-     * project level version control system releases) the project name as {projectName} within the string.
-     *
-     * The default releaseTagPattern for fixed/unified releases is: "v{version}"
-     * The default releaseTagPattern for independent releases at the project level is: "{projectName}@{version}"
+     * Enables using version plans as a specifier source for versioning and
+     * to determine changes for changelog generation.
      */
-    releaseTagPattern?: string;
-    /**
-     * Enable and configure automatic git operations as part of the release
-     */
-    git?: NxReleaseGitConfiguration;
-    conventionalCommits?: NxReleaseConventionalCommitsConfiguration;
+    versionPlans?: NxReleaseVersionPlansConfiguration | boolean;
 }
-type NxReleaseConventionalCommitsConfig = NonNullable<NxReleaseConfig["conventionalCommits"]>;
-type NxReleaseProjectsConfig = NonNullable<NxReleaseConfig["projects"]>;
-type NxReleaseGroupsConfig = NonNullable<NxReleaseConfig["groups"]>;
-type NxReleaseVersionConfig = NonNullable<NxReleaseConfig["version"]>;
-type NxReleaseGitConfig = NonNullable<NxReleaseConfig["git"]>;
-type NxReleaseChangelogConfig = NonNullable<NxReleaseConfig["changelog"]>;
-type NxReleaseGroupConfig = NxReleaseGroupsConfig[string];
+type ReleaseConfig = Omit<NxReleaseConfiguration, "groups" | "conventionalCommits"> & Required<Pick<NxReleaseConfig, "conventionalCommits">> & {
+    groups: Record<string, ReleaseGroupConfig>;
+};
 type NxReleaseRequiredGitConfig = Required<{
     commit?: boolean | undefined;
     commitMessage?: string | undefined;
@@ -239,4 +236,4 @@ type NxReleaseRequiredGitConfig = Required<{
     tagArgs?: string | undefined;
 }>;
 
-export { type CommitLintCLIOptions, type CommitLintOutcome, type CommitLintRuleOutcome, type CommitPromptMessagesEnum, type CommitQuestionProps, type CommitScopeProps, type CommitScopesEnum, type CommitSettingsEnum, type CommitState, DEFAULT_COMMIT_PROMPT_MESSAGES, type DeepPartial, type DefaultCommitPromptMessagesKeys, type NxReleaseChangelogConfig, type NxReleaseConfig, type NxReleaseConventionalCommitsConfig, type NxReleaseGitConfig, type NxReleaseGroupConfig, type NxReleaseGroupsConfig, type NxReleaseProjectsConfig, type NxReleaseRequiredGitConfig, type NxReleaseVersionConfig, type ReadMeOptions, type ReleaseConfig, type ReleaseContext };
+export { type CommitLintCLIOptions, type CommitLintOutcome, type CommitLintRuleOutcome, type CommitPromptMessagesEnum, type CommitQuestionProps, type CommitScopeProps, type CommitScopesEnum, type CommitSettingsEnum, type CommitState, DEFAULT_COMMIT_PROMPT_MESSAGES, type DeepPartial, type DefaultCommitPromptMessagesKeys, type NxReleaseRequiredGitConfig, type ReadMeOptions, type ReleaseConfig, type ReleaseContext, type ReleaseGroupConfig, type ReleaseOptions };

package/dist/types.js

@@ -1,6 +1 @@
-import {
-  DEFAULT_COMMIT_PROMPT_MESSAGES
-} from "./chunk-5XU2KBM6.js";
-export {
-  DEFAULT_COMMIT_PROMPT_MESSAGES
-};
+export { DEFAULT_COMMIT_PROMPT_MESSAGES } from './chunk-5XU2KBM6.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storm-software/git-tools",
-  "version": "2.123.16",
+  "version": "2.124.0",
   "type": "module",
   "description": "Tools for managing Git repositories within a Nx workspace.",
   "repository": {
@@ -183,10 +183,10 @@
     "@commitlint/ensure": "^19.8.1",
     "@commitlint/rules": "^19.8.1",
     "@inquirer/prompts": "7.2.1",
-    "@nx/devkit": "^21.4.1",
-    "@nx/js": "^21.4.1",
-    "@storm-software/config": "^1.134.16",
-    "@storm-software/config-tools": "^1.188.16",
+    "@nx/devkit": "^22.0.2",
+    "@nx/js": "^22.0.2",
+    "@storm-software/config": "^1.134.19",
+    "@storm-software/config-tools": "^1.188.19",
     "@textlint/ast-node-types": "14.4.2",
     "@textlint/markdown-to-ast": "14.4.2",
     "anchor-markdown-header": "0.7.0",
@@ -194,27 +194,27 @@
     "axios": "1.8.2",
     "chalk": "^4.1.2",
     "chalk-template": "1.1.0",
-    "conventional-changelog-storm-software": "^0.3.16",
+    "conventional-changelog-storm-software": "^0.3.19",
     "htmlparser2": "10.0.0",
     "jsonc-parser": "3.2.1",
-    "nx": "^21.4.1",
-    "prettier": "^3.5.1",
+    "nx": "^22.0.2",
+    "prettier": "^3.6.2",
     "tsconfig-paths": "4.2.0",
     "underscore": "1.13.7",
     "update-section": "0.3.3",
     "word-wrap": "1.2.5",
     "yaml": "^2.8.1",
-    "zod": "^4.1.11"
+    "zod": "^4.1.12"
   },
   "devDependencies": {
-    "@types/node": "^22.10.2",
+    "@types/node": "^22.19.0",
     "commander": "^12.1.0",
     "conventional-commits-parser": "^6.2.1",
     "defu": "6.1.4",
     "semver": "7.6.2",
-    "simple-git": "^3.29.0",
+    "simple-git": "^3.30.0",
     "tsup": "8.4.0"
   },
   "publishConfig": { "access": "public" },
-  "gitHead": "3d3ff971d19a1152c39c5cf03e8ed30d79516188"
+  "gitHead": "9369e3660228db8159c75d45109d4a76a4314382"
 }

package/dist/chunk-GOKUSEH3.cjs

@@ -1,77 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
-
-var _chunkNY53WLGCcjs = require('./chunk-NY53WLGC.cjs');
-
-
-var _chunk4VPJA7YJcjs = require('./chunk-4VPJA7YJ.cjs');
-
-// src/release/config.ts
-var DEFAULT_CONVENTIONAL_COMMITS_CONFIG = {
-  questions: _chunkNY53WLGCcjs.DEFAULT_MONOREPO_COMMIT_QUESTIONS,
-  types: _chunk4VPJA7YJcjs.DEFAULT_COMMIT_TYPES
-};
-var DEFAULT_RELEASE_GROUP_CONFIG = {
-  projectsRelationship: "independent",
-  releaseTagPattern: "{projectName}@{version}",
-  changelog: {
-    git: {
-      tag: true
-    },
-    createRelease: "github",
-    entryWhenNoChanges: false,
-    file: "{projectRoot}/CHANGELOG.md",
-    renderOptions: {
-      authors: false,
-      commitReferences: true,
-      versionTitleDate: true
-    }
-  },
-  version: {
-    groupPreVersionCommand: "pnpm build",
-    useLegacyVersioning: true,
-    currentVersionResolver: "git-tag",
-    specifierSource: "conventional-commits",
-    generator: "@storm-software/workspace-tools:release-version",
-    generatorOptions: {
-      currentVersionResolver: "git-tag",
-      specifierSource: "conventional-commits"
-    }
-  }
-};
-var DEFAULT_RELEASE_CONFIG = {
-  conventionalCommits: DEFAULT_CONVENTIONAL_COMMITS_CONFIG,
-  changelog: {
-    git: {
-      tag: true
-    },
-    automaticFromRef: true,
-    workspaceChangelog: false,
-    projectChangelogs: {
-      createRelease: "github",
-      entryWhenNoChanges: false,
-      file: "{projectRoot}/CHANGELOG.md",
-      renderOptions: {
-        authors: false,
-        commitReferences: true,
-        versionTitleDate: true
-      }
-    }
-  },
-  version: {
-    preVersionCommand: "pnpm build",
-    useLegacyVersioning: true,
-    currentVersionResolver: "git-tag",
-    specifierSource: "conventional-commits",
-    generator: "@storm-software/workspace-tools:release-version",
-    generatorOptions: {
-      currentVersionResolver: "git-tag",
-      specifierSource: "conventional-commits"
-    }
-  }
-};
-
-
-
-
-
-exports.DEFAULT_CONVENTIONAL_COMMITS_CONFIG = DEFAULT_CONVENTIONAL_COMMITS_CONFIG; exports.DEFAULT_RELEASE_GROUP_CONFIG = DEFAULT_RELEASE_GROUP_CONFIG; exports.DEFAULT_RELEASE_CONFIG = DEFAULT_RELEASE_CONFIG;

package/dist/chunk-YCEUZFMU.js

@@ -1,77 +0,0 @@
-import {
-  DEFAULT_MONOREPO_COMMIT_QUESTIONS
-} from "./chunk-JCEVFJCA.js";
-import {
-  DEFAULT_COMMIT_TYPES
-} from "./chunk-3GGWHKRP.js";
-
-// src/release/config.ts
-var DEFAULT_CONVENTIONAL_COMMITS_CONFIG = {
-  questions: DEFAULT_MONOREPO_COMMIT_QUESTIONS,
-  types: DEFAULT_COMMIT_TYPES
-};
-var DEFAULT_RELEASE_GROUP_CONFIG = {
-  projectsRelationship: "independent",
-  releaseTagPattern: "{projectName}@{version}",
-  changelog: {
-    git: {
-      tag: true
-    },
-    createRelease: "github",
-    entryWhenNoChanges: false,
-    file: "{projectRoot}/CHANGELOG.md",
-    renderOptions: {
-      authors: false,
-      commitReferences: true,
-      versionTitleDate: true
-    }
-  },
-  version: {
-    groupPreVersionCommand: "pnpm build",
-    useLegacyVersioning: true,
-    currentVersionResolver: "git-tag",
-    specifierSource: "conventional-commits",
-    generator: "@storm-software/workspace-tools:release-version",
-    generatorOptions: {
-      currentVersionResolver: "git-tag",
-      specifierSource: "conventional-commits"
-    }
-  }
-};
-var DEFAULT_RELEASE_CONFIG = {
-  conventionalCommits: DEFAULT_CONVENTIONAL_COMMITS_CONFIG,
-  changelog: {
-    git: {
-      tag: true
-    },
-    automaticFromRef: true,
-    workspaceChangelog: false,
-    projectChangelogs: {
-      createRelease: "github",
-      entryWhenNoChanges: false,
-      file: "{projectRoot}/CHANGELOG.md",
-      renderOptions: {
-        authors: false,
-        commitReferences: true,
-        versionTitleDate: true
-      }
-    }
-  },
-  version: {
-    preVersionCommand: "pnpm build",
-    useLegacyVersioning: true,
-    currentVersionResolver: "git-tag",
-    specifierSource: "conventional-commits",
-    generator: "@storm-software/workspace-tools:release-version",
-    generatorOptions: {
-      currentVersionResolver: "git-tag",
-      specifierSource: "conventional-commits"
-    }
-  }
-};
-
-export {
-  DEFAULT_CONVENTIONAL_COMMITS_CONFIG,
-  DEFAULT_RELEASE_GROUP_CONFIG,
-  DEFAULT_RELEASE_CONFIG
-};