nx 22.0.0-beta.3 → 22.0.0-beta.5

package/src/command-line/release/utils/release-graph.d.ts

@@ -0,0 +1,219 @@
+import type { NxReleaseDockerConfiguration, NxReleaseVersionConfiguration } from '../../../config/nx-json';
+import type { ProjectGraph } from '../../../config/project-graph';
+import type { Tree } from '../../../generators/tree';
+import { type NxReleaseConfig } from '../config/config';
+import type { ReleaseGroupWithName } from '../config/filter-release-groups';
+import { ProjectLogger } from '../version/project-logger';
+import { type AfterAllProjectsVersioned, type VersionActions } from '../version/version-actions';
+/**
+ * Final configuration for a project after applying release group and project level overrides
+ */
+export interface FinalConfigForProject {
+    specifierSource: NxReleaseVersionConfiguration['specifierSource'];
+    currentVersionResolver: NxReleaseVersionConfiguration['currentVersionResolver'];
+    currentVersionResolverMetadata: NxReleaseVersionConfiguration['currentVersionResolverMetadata'];
+    fallbackCurrentVersionResolver: NxReleaseVersionConfiguration['fallbackCurrentVersionResolver'];
+    versionPrefix: NxReleaseVersionConfiguration['versionPrefix'];
+    preserveLocalDependencyProtocols: NxReleaseVersionConfiguration['preserveLocalDependencyProtocols'];
+    preserveMatchingDependencyRanges: NxReleaseVersionConfiguration['preserveMatchingDependencyRanges'];
+    versionActionsOptions: NxReleaseVersionConfiguration['versionActionsOptions'];
+    manifestRootsToUpdate: Array<Exclude<NxReleaseVersionConfiguration['manifestRootsToUpdate'][number], string>>;
+    dockerOptions: NxReleaseDockerConfiguration & {
+        groupPreVersionCommand?: string;
+    };
+}
+interface GroupNode {
+    group: ReleaseGroupWithName;
+    dependencies: Set<string>;
+    dependents: Set<string>;
+}
+export interface CreateReleaseGraphOptions {
+    tree: Tree;
+    projectGraph: ProjectGraph;
+    nxReleaseConfig: NxReleaseConfig;
+    filters: {
+        projects?: string[];
+        groups?: string[];
+    };
+    firstRelease: boolean;
+    preid?: string;
+    verbose: boolean;
+    /**
+     * Current version resolution is not needed for publishing, so in cases where the publish subcommand needs to build a release graph,
+     * we allow it to skip this step.
+     */
+    skipVersionResolution?: boolean;
+    versionActionsOptionsOverrides?: Record<string, unknown>;
+}
+export declare const validReleaseVersionPrefixes: readonly ["auto", "", "~", "^", "="];
+/**
+ * The complete release graph containing all relationships, caches, and computed data
+ * necessary for efficient release operations across versioning, changelog, and publishing.
+ *
+ * This class encapsulates the complex dependency graph between projects and release groups,
+ * providing convenient methods for querying relationships and accessing cached data.
+ */
+export declare class ReleaseGraph {
+    releaseGroups: ReleaseGroupWithName[];
+    readonly filters: {
+        projects?: string[];
+        groups?: string[];
+    };
+    readonly projectToReleaseGroup: Map<string, ReleaseGroupWithName>;
+    readonly projectToDependents: Map<string, Set<string>>;
+    readonly projectToDependencies: Map<string, Set<string>>;
+    readonly projectToUpdateDependentsSetting: Map<string, "never" | "auto" | "always">;
+    readonly groupGraph: Map<string, GroupNode>;
+    sortedReleaseGroups: string[];
+    readonly sortedProjects: Map<string, string[]>;
+    readonly allProjectsConfiguredForNxRelease: Set<string>;
+    allProjectsToProcess: Set<string>;
+    readonly finalConfigsByProject: Map<string, FinalConfigForProject>;
+    readonly projectsToVersionActions: Map<string, VersionActions>;
+    readonly uniqueAfterAllProjectsVersioned: Map<string, AfterAllProjectsVersioned>;
+    readonly projectLoggers: Map<string, ProjectLogger>;
+    readonly cachedCurrentVersions: Map<string, string>;
+    readonly cachedLatestMatchingGitTag: Map<string, import("./git").GitTagAndVersion>;
+    readonly currentVersionsPerFixedReleaseGroup: Map<string, {
+        currentVersion: string;
+        originatingProjectName: string;
+        logText: string;
+    }>;
+    readonly originalDependentProjectsPerProject: Map<string, {
+        source: string;
+        target: string;
+        type: string;
+        dependencyCollection: string;
+        rawVersionSpec: string;
+    }[]>;
+    readonly releaseGroupToFilteredProjects: Map<ReleaseGroupWithName, Set<string>>;
+    private originalFilteredProjects;
+    /**
+     * User-friendly log describing what the filter matched.
+     * Null if no filters were applied.
+     */
+    filterLog: {
+        title: string;
+        bodyLines: string[];
+    } | null;
+    constructor(releaseGroups: ReleaseGroupWithName[], filters: {
+        projects?: string[];
+        groups?: string[];
+    });
+    /**
+     * Initialize the graph by building all relationships and caches
+     * @internal - Called by createReleaseGraph(), not meant for external use
+     */
+    init(options: CreateReleaseGraphOptions): Promise<void>;
+    /**
+     * Setup mapping from project to release group and cache updateDependents settings
+     */
+    private setupProjectReleaseGroupMapping;
+    /**
+     * Apply initial filtering to construct releaseGroupToFilteredProjects based on filters.
+     * This determines the base set of projects and groups before considering dependencies.
+     */
+    private applyInitialFiltering;
+    /**
+     * Check if any filters are applied
+     */
+    private hasAnyFilters;
+    /**
+     * Setup projects to process and resolve version actions
+     */
+    private setupProjectsToProcess;
+    /**
+     * Precompute dependency relationships between all projects
+     */
+    private precomputeDependencyRelationships;
+    /**
+     * Apply dependency-aware filtering that considers updateDependents configuration.
+     * This includes transitive dependents based on updateDependents setting ('always' by default, or 'auto').
+     */
+    private applyDependencyAwareFiltering;
+    /**
+     * Validate that the filter doesn't try to isolate projects in fixed release groups
+     */
+    private validateFilterAgainstFixedGroups;
+    /**
+     * Find dependents that should be included in processing based on updateDependents configuration
+     */
+    private findDependentsToProcess;
+    /**
+     * Generate user-friendly log describing what the filter matched
+     */
+    private generateFilterLog;
+    /**
+     * Build the group graph structure
+     */
+    private buildGroupGraphStructure;
+    /**
+     * Resolve current versions for all projects that will be processed
+     */
+    private resolveCurrentVersionsForProjects;
+    /**
+     * Build dependency relationships between release groups
+     */
+    private buildGroupDependencyGraph;
+    /**
+     * Topologically sort release groups
+     */
+    private topologicallySortReleaseGroups;
+    /**
+     * Topologically sort projects within a release group
+     */
+    private topologicallySortProjects;
+    private populateDependentProjectsData;
+    /**
+     * Get all non-implicit dependents for a set of projects
+     */
+    private getAllNonImplicitDependents;
+    /**
+     * Resolve final configuration for a project
+     *
+     * NOTE: We are providing ultimate fallback values via ?? here mainly just to keep TypeScript happy.
+     * All default values should have been applied by this point by config.ts but the types can't know
+     * that for sure at this point.
+     */
+    private static resolveFinalConfigForProject;
+    /**
+     * Get the release group for a given project
+     */
+    getReleaseGroupForProject(projectName: string): ReleaseGroupWithName | undefined;
+    /**
+     * Get the release group name for a given project
+     */
+    getReleaseGroupNameForProject(projectName: string): string | null;
+    /**
+     * Get the dependencies of a project
+     */
+    getProjectDependencies(projectName: string): Set<string>;
+    /**
+     * Get the dependents of a project (projects that depend on it)
+     */
+    getProjectDependents(projectName: string): Set<string>;
+    /**
+     * Get the version actions for a project
+     */
+    getVersionActionsForProject(projectName: string): VersionActions | undefined;
+    /**
+     * Check if a project will be processed
+     */
+    isProjectToProcess(projectName: string): boolean;
+    /**
+     * Runs validation on resolved VersionActions instances. E.g. check that manifest files exist for all projects that will be processed.
+     * This should be called after preVersionCommand has run, as those commands may create manifest files that are needed for versioning.
+     */
+    validate(tree: Tree): Promise<void>;
+}
+/**
+ * Creates a complete release graph by analyzing all release groups, projects, and their relationships.
+ *
+ * This function builds the graph structure, applies filtering logic that considers dependencies
+ * and updateDependents configuration, and caches all necessary data.
+ *
+ * The returned graph can be reused across versioning, changelog, and publishing operations.
+ */
+export declare function createReleaseGraph(options: CreateReleaseGraphOptions): Promise<ReleaseGraph>;
+export {};
+//# sourceMappingURL=release-graph.d.ts.map

package/src/command-line/release/utils/release-graph.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"release-graph.d.ts","sourceRoot":"","sources":["../../../../../../../packages/nx/src/command-line/release/utils/release-graph.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,4BAA4B,EAC5B,6BAA6B,EAC9B,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EACV,YAAY,EAEb,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAEL,KAAK,eAAe,EACrB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAG1D,OAAO,EAGL,KAAK,yBAAyB,EAC9B,KAAK,cAAc,EACpB,MAAM,4BAA4B,CAAC;AAIpC;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,eAAe,EAAE,6BAA6B,CAAC,iBAAiB,CAAC,CAAC;IAClE,sBAAsB,EAAE,6BAA6B,CAAC,wBAAwB,CAAC,CAAC;IAChF,8BAA8B,EAAE,6BAA6B,CAAC,gCAAgC,CAAC,CAAC;IAChG,8BAA8B,EAAE,6BAA6B,CAAC,gCAAgC,CAAC,CAAC;IAChG,aAAa,EAAE,6BAA6B,CAAC,eAAe,CAAC,CAAC;IAC9D,gCAAgC,EAAE,6BAA6B,CAAC,kCAAkC,CAAC,CAAC;IACpG,gCAAgC,EAAE,6BAA6B,CAAC,kCAAkC,CAAC,CAAC;IACpG,qBAAqB,EAAE,6BAA6B,CAAC,uBAAuB,CAAC,CAAC;IAC9E,qBAAqB,EAAE,KAAK,CAC1B,OAAO,CACL,6BAA6B,CAAC,uBAAuB,CAAC,CAAC,MAAM,CAAC,EAC9D,MAAM,CACP,CACF,CAAC;IACF,aAAa,EAAE,4BAA4B,GAAG;QAC5C,sBAAsB,CAAC,EAAE,MAAM,CAAC;KACjC,CAAC;CACH;AAED,UAAU,SAAS;IACjB,KAAK,EAAE,oBAAoB,CAAC;IAC5B,YAAY,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC1B,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,IAAI,CAAC;IACX,YAAY,EAAE,YAAY,CAAC;IAC3B,eAAe,EAAE,eAAe,CAAC;IACjC,OAAO,EAAE;QACP,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;QACpB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;KACnB,CAAC;IACF,YAAY,EAAE,OAAO,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,8BAA8B,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC1D;AAED,eAAO,MAAM,2BAA2B,sCAAuC,CAAC;AAEhF;;;;;;GAMG;AACH,qBAAa,YAAY;IAkDd,aAAa,EAAE,oBAAoB,EAAE;aAC5B,OAAO,EAAE;QACvB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;QACpB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;KACnB;IArDH,QAAQ,CAAC,qBAAqB,oCAA2C;IACzE,QAAQ,CAAC,mBAAmB,2BAAkC;IAC9D,QAAQ,CAAC,qBAAqB,2BAAkC;IAChE,QAAQ,CAAC,gCAAgC,2CAGrC;IACJ,QAAQ,CAAC,UAAU,yBAAgC;IACnD,mBAAmB,EAAE,MAAM,EAAE,CAAM;IACnC,QAAQ,CAAC,cAAc,wBAA+B;IACtD,QAAQ,CAAC,iCAAiC,cAAqB;IAC/D,oBAAoB,cAAqB;IACzC,QAAQ,CAAC,qBAAqB,qCAA4C;IAC1E,QAAQ,CAAC,wBAAwB,8BAAqC;IACtE,QAAQ,CAAC,+BAA+B,yCAGpC;IACJ,QAAQ,CAAC,cAAc,6BAAoC;IAC3D,QAAQ,CAAC,qBAAqB,sBAAoC;IAClE,QAAQ,CAAC,0BAA0B,gDAG/B;IACJ,QAAQ,CAAC,mCAAmC;wBAGxB,MAAM;gCACE,MAAM;iBACrB,MAAM;OAEf;IACJ,QAAQ,CAAC,mCAAmC;;;;;;SAGxC;IACJ,QAAQ,CAAC,8BAA8B,yCAGnC;IACJ,OAAO,CAAC,wBAAwB,CAAqB;IAErD;;;OAGG;IACH,SAAS,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,EAAE,CAAA;KAAE,GAAG,IAAI,CAAQ;gBAGvD,aAAa,EAAE,oBAAoB,EAAE,EAC5B,OAAO,EAAE;QACvB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;QACpB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;KACnB;IAGH;;;OAGG;IACG,IAAI,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IAkD7D;;OAEG;IACH,OAAO,CAAC,+BAA+B;IAavC;;;OAGG;IACH,OAAO,CAAC,qBAAqB;IAsD7B;;OAEG;IACH,OAAO,CAAC,aAAa;IAIrB;;OAEG;YACW,sBAAsB;IA0FpC;;OAEG;YACW,iCAAiC;IA4B/C;;;OAGG;IACH,OAAO,CAAC,6BAA6B;IAmBrC;;OAEG;IACH,OAAO,CAAC,gCAAgC;IA6BxC;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAqG/B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAuBzB;;OAEG;IACH,OAAO,CAAC,wBAAwB;IAahC;;OAEG;YACW,iCAAiC;IA0D/C;;OAEG;IACH,OAAO,CAAC,yBAAyB;IAqBjC;;OAEG;IACH,OAAO,CAAC,8BAA8B;IActC;;OAEG;IACH,OAAO,CAAC,yBAAyB;YAmBnB,6BAA6B;IAqC3C;;OAEG;IACH,OAAO,CAAC,2BAA2B;IAMnC;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,4BAA4B;IAiK3C;;OAEG;IACH,yBAAyB,CACvB,WAAW,EAAE,MAAM,GAClB,oBAAoB,GAAG,SAAS;IAInC;;OAEG;IACH,6BAA6B,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAKjE;;OAEG;IACH,sBAAsB,CAAC,WAAW,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IAIxD;;OAEG;IACH,oBAAoB,CAAC,WAAW,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IAItD;;OAEG;IACH,2BAA2B,CAAC,WAAW,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAI5E;;OAEG;IACH,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO;IAIhD;;;OAGG;IACG,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CAa1C;AAED;;;;;;;GAOG;AACH,wBAAsB,kBAAkB,CACtC,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,YAAY,CAAC,CAgBvB"}