Skip to content

Fixed an issue with the assembleReleasePlan's signature not being compatible with the old shape of the config and snapshot parameters #914

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Andarist merged 1 commit into from
Aug 14, 2022
Merged

Fixed an issue with the assembleReleasePlan's signature not being compatible with the old shape of the config and snapshot parameters #914

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/young-dolphins-rest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@changesets/assemble-release-plan": patch
---

Fixed an issue with the `assembleReleasePlan`'s signature not being compatible with the old shape of the `config` and `snapshot` parameters. This could have caused runtime errors during snapshot releases when only some of the Changesets transitive dependencies were updated without other ones.
58 changes: 46 additions & 12 deletions packages/assemble-release-plan/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,41 +117,67 @@ function getNewVersion(
return incrementVersion(release, preInfo);
}

type OptionalProp<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;

function assembleReleasePlan(
changesets: NewChangeset[],
packages: Packages,
config: Config,
config: OptionalProp<Config, "snapshot">,
// intentionally not using an optional parameter here so the result of `readPreState` has to be passed in here
preState: PreState | undefined,
// snapshot: undefined -> not using snaphot
// snapshot: { tag: undefined } -> --snapshot (empty tag)
// snapshot: { tag: "canary" } -> --snapshot canary
snapshot?: SnapshotReleaseParameters
snapshot?: SnapshotReleaseParameters | string | boolean
): ReleasePlan {
// TODO: remove `refined*` in the next major version of this package
// just use `config` and `snapshot` parameters directly, typed as: `config: Config, snapshot?: SnapshotReleaseParameters`
const refinedConfig: Config = config.snapshot
? (config as Config)
: {
...config,
snapshot: {
prereleaseTemplate: null,
useCalculatedVersion: (config.___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH as any)
.useCalculatedVersionForSnapshots
}
};
const refinedSnapshot: SnapshotReleaseParameters | undefined =
typeof snapshot === "string"
? { tag: snapshot }
: typeof snapshot === "boolean"
? { tag: undefined }
: snapshot;

let packagesByName = new Map(
packages.packages.map(x => [x.packageJson.name, x])
);

const relevantChangesets = getRelevantChangesets(
changesets,
config.ignore,
refinedConfig.ignore,
preState
);

const preInfo = getPreInfo(changesets, packagesByName, config, preState);
const preInfo = getPreInfo(
changesets,
packagesByName,
refinedConfig,
preState
);

// releases is, at this point a list of all packages we are going to releases,
// flattened down to one release per package, having a reference back to their
// changesets, and with a calculated new versions
let releases = flattenReleases(
relevantChangesets,
packagesByName,
config.ignore
refinedConfig.ignore
);

let dependencyGraph = getDependentsGraph(packages, {
bumpVersionsWithWorkspaceProtocolOnly:
config.bumpVersionsWithWorkspaceProtocolOnly
refinedConfig.bumpVersionsWithWorkspaceProtocolOnly
});

let releasesValidated = false;
Expand All @@ -162,16 +188,20 @@ function assembleReleasePlan(
packagesByName,
dependencyGraph,
preInfo,
config
config: refinedConfig
});

// `releases` might get mutated here
let fixedConstraintUpdated = matchFixedConstraint(
releases,
packagesByName,
config
refinedConfig
);
let linksUpdated = applyLinks(
releases,
packagesByName,
refinedConfig.linked
);
let linksUpdated = applyLinks(releases, packagesByName, config.linked);

releasesValidated =
!linksUpdated && !dependentAdded && !fixedConstraintUpdated;
Expand All @@ -193,7 +223,7 @@ function assembleReleasePlan(
});
} else if (
existingRelease.type === "none" &&
!config.ignore.includes(pkg.packageJson.name)
!refinedConfig.ignore.includes(pkg.packageJson.name)
) {
existingRelease.type = "patch";
}
Expand All @@ -203,7 +233,11 @@ function assembleReleasePlan(

// Caching the snapshot version here and use this if it is snapshot release
const snapshotSuffix =
snapshot && getSnapshotSuffix(config.snapshot.prereleaseTemplate, snapshot);
refinedSnapshot &&
getSnapshotSuffix(
refinedConfig.snapshot.prereleaseTemplate,
refinedSnapshot
);

return {
changesets: relevantChangesets,
Expand All @@ -214,7 +248,7 @@ function assembleReleasePlan(
? getSnapshotVersion(
incompleteRelease,
preInfo,
config.snapshot.useCalculatedVersion,
refinedConfig.snapshot.useCalculatedVersion,
snapshotSuffix
)
: getNewVersion(incompleteRelease, preInfo)
Expand Down