@storm-software/git-tools 2.123.16 → 2.123.18

package/dist/release/config.d.ts

@@ -1,5 +1,5 @@
 import * as conventional_changelog_storm_software_types_commit_types from 'conventional-changelog-storm-software/types/commit-types';
-import { CommitScopesEnum } from '../types.js';
+import { CommitScopesEnum, ReleaseGroupConfig, ReleaseConfig } from '../types.js';
 import '@nx/devkit';
 import '@storm-software/config/types';
 import 'conventional-changelog-storm-software/types/commitlint';
@@ -193,251 +193,30 @@ declare const DEFAULT_CONVENTIONAL_COMMITS_CONFIG: {
         };
     };
 };
+declare const DEFAULT_RELEASE_TAG_PATTERN = "{projectName}@{version}";
 declare const DEFAULT_RELEASE_GROUP_CONFIG: {
-    projectsRelationship: string;
-    releaseTagPattern: string;
-    changelog: {
-        git: {
-            tag: boolean;
-        };
-        createRelease: string;
-        entryWhenNoChanges: boolean;
-        file: string;
-        renderOptions: {
-            authors: boolean;
-            commitReferences: boolean;
-            versionTitleDate: boolean;
-        };
-    };
-    version: {
-        groupPreVersionCommand: string;
-        useLegacyVersioning: boolean;
-        currentVersionResolver: string;
-        specifierSource: string;
-        generator: string;
-        generatorOptions: {
-            currentVersionResolver: string;
-            specifierSource: string;
-        };
-    };
-};
-declare const DEFAULT_RELEASE_CONFIG: {
-    conventionalCommits: {
-        questions: {
-            readonly type: {
-                readonly type: "select";
-                readonly title: "Commit Type";
-                readonly description: "Select the commit type that best describes your changes";
-                readonly enum: conventional_changelog_storm_software_types_commit_types.CommitTypesEnum;
-                readonly defaultValue: "chore";
-                readonly maxLength: 20;
-                readonly minLength: 3;
-            };
-            readonly scope: {
-                readonly type: "select";
-                readonly title: "Commit Scope";
-                readonly description: "Select the project that's the most impacted by this change";
-                readonly enum: CommitScopesEnum;
-                readonly defaultValue: "monorepo";
-                readonly maxLength: 50;
-                readonly minLength: 1;
-            };
-            readonly subject: {
-                readonly type: "input";
-                readonly title: "Commit Subject";
-                readonly description: "Write a short, imperative tense description of the change";
-                readonly maxLength: 150;
-                readonly minLength: 3;
-            };
-            readonly body: {
-                readonly type: "input";
-                readonly title: "Commit Body";
-                readonly description: "Provide a longer description of the change";
-                readonly maxLength: 600;
-            };
-            readonly isBreaking: {
-                readonly type: "confirm";
-                readonly title: "Breaking Changes";
-                readonly description: "Are there any breaking changes as a result of this commit?";
-                readonly defaultValue: false;
-            };
-            readonly breakingBody: {
-                readonly type: "input";
-                readonly title: "Breaking Changes (Details)";
-                readonly description: "A BREAKING CHANGE commit requires a body. Please enter a longer description of the commit itself";
-                readonly when: (answers: Record<string, any>) => boolean;
-                readonly maxLength: 600;
-                readonly minLength: 3;
-            };
-            readonly isIssueAffected: {
-                readonly type: "confirm";
-                readonly title: "Open Issue Affected";
-                readonly description: "Does this change impact any open issues?";
-                readonly defaultValue: false;
-            };
-            readonly issuesBody: {
-                readonly type: "input";
-                readonly title: "Open Issue Affected (Details)";
-                readonly description: "If issues are closed, the commit requires a body. Please enter a longer description of the commit itself";
-                readonly when: (answers: Record<string, any>) => boolean;
-                readonly maxLength: 600;
-                readonly minLength: 3;
-            };
-        };
-        types: {
-            readonly chore: {
-                readonly description: "Other changes that don't modify src or test files";
-                readonly title: "Chore";
-                readonly emoji: "⚙️  ";
-                readonly semverBump: "patch";
-                readonly changelog: {
-                    readonly title: "Miscellaneous";
-                    readonly hidden: false;
-                };
-            };
-            readonly fix: {
-                readonly description: "A change that resolves an issue previously identified with the package";
-                readonly title: "Bug Fix";
-                readonly emoji: "🪲  ";
-                readonly semverBump: "patch";
-                readonly changelog: {
-                    readonly title: "Bug Fixes";
-                    readonly hidden: false;
-                };
-            };
-            readonly feat: {
-                readonly description: "A change that adds a new feature to the package";
-                readonly title: "Feature";
-                readonly emoji: "🔑 ";
-                readonly semverBump: "minor";
-                readonly changelog: {
-                    readonly title: "Features";
-                    readonly hidden: false;
-                };
-            };
-            readonly ci: {
-                readonly description: "Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)";
-                readonly title: "Continuous Integration";
-                readonly emoji: "🧰 ";
-                readonly semverBump: "patch";
-                readonly changelog: {
-                    readonly title: "Continuous Integration";
-                    readonly hidden: false;
-                };
-            };
-            readonly refactor: {
-                readonly description: "A code change that neither fixes a bug nor adds a feature";
-                readonly title: "Code Refactoring";
-                readonly emoji: "🧪 ";
-                readonly semverBump: "patch";
-                readonly changelog: {
-                    readonly title: "Source Code Improvements";
-                    readonly hidden: false;
-                };
-            };
-            readonly style: {
-                readonly description: "Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)";
-                readonly title: "Style Improvements";
-                readonly emoji: "💎 ";
-                readonly semverBump: "patch";
-                readonly changelog: {
-                    readonly title: "Style Improvements";
-                    readonly hidden: false;
-                };
-            };
-            readonly perf: {
-                readonly description: "A code change that improves performance";
-                readonly title: "Performance Improvement";
-                readonly emoji: "⏱️  ";
-                readonly semverBump: "patch";
-                readonly changelog: {
-                    readonly title: "Performance Improvements";
-                    readonly hidden: false;
-                };
-            };
-            readonly docs: {
-                readonly description: "A change that only includes documentation updates";
-                readonly title: "Documentation";
-                readonly emoji: "📜 ";
-                readonly semverBump: "none";
-                readonly changelog: {
-                    readonly title: "Documentation";
-                    readonly hidden: false;
-                };
-            };
-            readonly test: {
-                readonly description: "Adding missing tests or correcting existing tests";
-                readonly title: "Testing";
-                readonly emoji: "🚨 ";
-                readonly semverBump: "none";
-                readonly changelog: {
-                    readonly title: "Testing";
-                    readonly hidden: true;
-                };
-            };
-            readonly deps: {
-                readonly description: "Changes that add, update, or remove dependencies. This includes devDependencies and peerDependencies";
-                readonly title: "Dependencies";
-                readonly emoji: "📦 ";
-                readonly hidden: true;
-                readonly semverBump: "patch";
-                readonly changelog: {
-                    readonly title: "Dependency Upgrades";
-                    readonly hidden: false;
-                };
-            };
-            readonly build: {
-                readonly description: "Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)";
-                readonly title: "Build";
-                readonly emoji: "🛠 ";
-                readonly hidden: true;
-                readonly semverBump: "none";
-                readonly changelog: {
-                    readonly title: "Build";
-                    readonly hidden: true;
-                };
-            };
-            readonly release: {
-                readonly description: "Publishing a commit containing a newly released version";
-                readonly title: "Publish Release";
-                readonly emoji: "🚀 ";
-                readonly hidden: true;
-                readonly semverBump: "none";
-                readonly changelog: {
-                    readonly title: "Publish Release";
-                    readonly hidden: true;
-                };
-            };
+    readonly projectsRelationship: "independent";
+    readonly changelog: {
+        readonly createRelease: "github";
+        readonly entryWhenNoChanges: false;
+        readonly file: false;
+        readonly renderOptions: {
+            readonly authors: false;
+            readonly commitReferences: true;
+            readonly versionTitleDate: true;
         };
     };
-    changelog: {
-        git: {
-            tag: boolean;
-        };
-        automaticFromRef: boolean;
-        workspaceChangelog: boolean;
-        projectChangelogs: {
-            createRelease: string;
-            entryWhenNoChanges: boolean;
-            file: string;
-            renderOptions: {
-                authors: boolean;
-                commitReferences: boolean;
-                versionTitleDate: boolean;
-            };
-        };
+    readonly version: {
+        readonly currentVersionResolver: "git-tag";
+        readonly specifierSource: "conventional-commits";
+        readonly groupPreVersionCommand: "pnpm build";
     };
-    version: {
-        preVersionCommand: string;
-        useLegacyVersioning: boolean;
-        currentVersionResolver: string;
-        specifierSource: string;
-        generator: string;
-        generatorOptions: {
-            currentVersionResolver: string;
-            specifierSource: string;
-        };
+    readonly releaseTag: {
+        readonly pattern: "{projectName}@{version}";
     };
 };
+declare const DEFAULT_JS_RELEASE_GROUP_CONFIG: ReleaseGroupConfig;
+declare const DEFAULT_RUST_RELEASE_GROUP_CONFIG: ReleaseGroupConfig;
+declare const DEFAULT_RELEASE_CONFIG: ReleaseConfig;
 
-export { DEFAULT_CONVENTIONAL_COMMITS_CONFIG, DEFAULT_RELEASE_CONFIG, DEFAULT_RELEASE_GROUP_CONFIG };
+export { DEFAULT_CONVENTIONAL_COMMITS_CONFIG, DEFAULT_JS_RELEASE_GROUP_CONFIG, DEFAULT_RELEASE_CONFIG, DEFAULT_RELEASE_GROUP_CONFIG, DEFAULT_RELEASE_TAG_PATTERN, DEFAULT_RUST_RELEASE_GROUP_CONFIG };

package/dist/release/config.js

@@ -1,14 +1,5 @@
-import {
-  DEFAULT_CONVENTIONAL_COMMITS_CONFIG,
-  DEFAULT_RELEASE_CONFIG,
-  DEFAULT_RELEASE_GROUP_CONFIG
-} from "../chunk-YCEUZFMU.js";
-import "../chunk-JCEVFJCA.js";
-import "../chunk-KZRVQ5RZ.js";
-import "../chunk-5XU2KBM6.js";
-import "../chunk-3GGWHKRP.js";
-export {
-  DEFAULT_CONVENTIONAL_COMMITS_CONFIG,
-  DEFAULT_RELEASE_CONFIG,
-  DEFAULT_RELEASE_GROUP_CONFIG
-};
+export { DEFAULT_CONVENTIONAL_COMMITS_CONFIG, DEFAULT_JS_RELEASE_GROUP_CONFIG, DEFAULT_RELEASE_CONFIG, DEFAULT_RELEASE_GROUP_CONFIG, DEFAULT_RELEASE_TAG_PATTERN, DEFAULT_RUST_RELEASE_GROUP_CONFIG } from '../chunk-PKEX4GUO.js';
+import '../chunk-JCEVFJCA.js';
+import '../chunk-KZRVQ5RZ.js';
+import '../chunk-5XU2KBM6.js';
+import '../chunk-3GGWHKRP.js';

package/dist/types.cjs

@@ -1,6 +1,10 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+'use strict';
 
-var _chunkYBAE6I5Lcjs = require('./chunk-YBAE6I5L.cjs');
+var chunkYBAE6I5L_cjs = require('./chunk-YBAE6I5L.cjs');
 
 
-exports.DEFAULT_COMMIT_PROMPT_MESSAGES = _chunkYBAE6I5Lcjs.DEFAULT_COMMIT_PROMPT_MESSAGES;
+
+Object.defineProperty(exports, "DEFAULT_COMMIT_PROMPT_MESSAGES", {
+  enumerable: true,
+  get: function () { return chunkYBAE6I5L_cjs.DEFAULT_COMMIT_PROMPT_MESSAGES; }
+});

package/dist/types.d.cts

@@ -2,7 +2,7 @@ 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 { 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 +72,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 +111,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"> & {
+    groups: Record<string, ReleaseGroupConfig>;
+};
 type NxReleaseRequiredGitConfig = Required<{
     commit?: boolean | undefined;
     commitMessage?: string | undefined;
@@ -239,4 +235,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 };