Skip to content
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.

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

Already on GitHub? Sign in to your account

Fixed an issue with none releases ending up as snapshot releases #706

Merged
merged 6 commits into from
Feb 16, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/calm-eggs-wonder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@changesets/assemble-release-plan": patch
"@changesets/cli": patch
---

Fixed an issue with `"none"` releases causing package versions being bumped during snapshot releases. In addition to when you create `"none"` release types explicitly Changesets might create them implicitly in some situations, for example under some circumstances this issue caused snapshot releases to be created sometimes for ignored packages.
3 changes: 3 additions & 0 deletions packages/assemble-release-plan/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ function getNewVersion(
snapshotSuffix: string | undefined,
useCalculatedVersionForSnapshots: boolean
): string {
if (release.type === "none") {
return release.oldVersion;
}
/**
* Using version as 0.0.0 so that it does not hinder with other version release
* For example;
Expand Down
207 changes: 200 additions & 7 deletions packages/cli/src/commands/version/version.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -191,19 +191,28 @@ describe("running version in a simple project", () => {

it("should not bump ignored packages", async () => {
await writeChangesets([simpleChangeset, simpleChangeset3], cwd);
const spy = jest.spyOn(fs, "writeFile");

await version(cwd, defaultOptions, {
...modifiedDefaultConfig,
ignore: ["pkg-a"]
});

expect(getPkgJSON("pkg-b", spy.mock.calls)).toEqual(
expect.objectContaining({ name: "pkg-b", version: "1.0.1" })
);
expect(getPkgJSON("pkg-a", spy.mock.calls)).toEqual(
expect.objectContaining({ name: "pkg-a", version: "1.0.0" })
);
expect((await getPackages(cwd)).packages.map(x => x.packageJson))
.toMatchInlineSnapshot(`
Array [
Object {
"dependencies": Object {
"pkg-b": "1.0.1",
},
"name": "pkg-a",
"version": "1.0.0",
},
Object {
"name": "pkg-b",
"version": "1.0.1",
},
]
`);
});

it("should not commit the result if commit config is not set", async () => {
Expand Down Expand Up @@ -516,6 +525,93 @@ describe("snapshot release", () => {
expect(spy).not.toHaveBeenCalled();
});

it("should not bump version of a package with an explicit none release type", async () => {
const cwd = await f.copy("simple-project");
await writeChangeset(
{
releases: [{ name: "pkg-a", type: "none" }],
summary: "some internal stuff"
},
cwd
);

await version(
cwd,
{
snapshot: true
},
modifiedDefaultConfig
);

expect((await getPackages(cwd)).packages.map(x => x.packageJson))
.toMatchInlineSnapshot(`
Array [
Object {
"dependencies": Object {
"pkg-b": "1.0.0",
},
"name": "pkg-a",
"version": "1.0.0",
},
Object {
"name": "pkg-b",
"version": "1.0.0",
},
]
`);
});

it("should not bump version of an ignored package when its dependency gets updated", async () => {
const originalDate = Date;
// eslint-disable-next-line no-global-assign
Date = class Date {
toISOString() {
return "2021-12-13T00:07:30.879Z";
}
} as any;
try {
const cwd = await f.copy("simple-project");
await writeChangeset(
{
releases: [{ name: "pkg-b", type: "major" }],
summary: "a very useful summary"
},
cwd
);

await version(
cwd,
{
snapshot: true
},
{
...modifiedDefaultConfig,
ignore: ["pkg-a"]
}
);

expect((await getPackages(cwd)).packages.map(x => x.packageJson))
.toMatchInlineSnapshot(`
Array [
Object {
"dependencies": Object {
"pkg-b": "0.0.0-20211213000730",
},
"name": "pkg-a",
"version": "1.0.0",
},
Object {
"name": "pkg-b",
"version": "0.0.0-20211213000730",
},
]
`);
} finally {
// eslint-disable-next-line no-global-assign
Date = originalDate;
}
});

describe("useCalculatedVersionForSnapshots: true", () => {
it("should update packages using calculated version", async () => {
let cwd = f.copy("simple-project");
Expand Down Expand Up @@ -549,6 +645,103 @@ describe("snapshot release", () => {
})
);
});

it("should not bump version of a package with an explicit none release type", async () => {
const cwd = await f.copy("simple-project");
await writeChangeset(
{
releases: [{ name: "pkg-a", type: "none" }],
summary: "some internal stuff"
},
cwd
);

await version(
cwd,
{
snapshot: true
},
{
...modifiedDefaultConfig,
___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: {
...modifiedDefaultConfig.___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH,
useCalculatedVersionForSnapshots: true
}
}
);

expect((await getPackages(cwd)).packages.map(x => x.packageJson))
.toMatchInlineSnapshot(`
Array [
Object {
"dependencies": Object {
"pkg-b": "1.0.0",
},
"name": "pkg-a",
"version": "1.0.0",
},
Object {
"name": "pkg-b",
"version": "1.0.0",
},
]
`);
});

it("should not bump version of an ignored package when its dependency gets updated", async () => {
const originalDate = Date;
// eslint-disable-next-line no-global-assign
Date = class Date {
toISOString() {
return "2021-12-13T00:07:30.879Z";
}
} as any;
try {
const cwd = await f.copy("simple-project");
await writeChangeset(
{
releases: [{ name: "pkg-b", type: "major" }],
summary: "a very useful summary"
},
cwd
);

await version(
cwd,
{
snapshot: true
},
{
...modifiedDefaultConfig,
ignore: ["pkg-a"],
___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: {
...modifiedDefaultConfig.___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH,
useCalculatedVersionForSnapshots: true
}
}
);

expect((await getPackages(cwd)).packages.map(x => x.packageJson))
.toMatchInlineSnapshot(`
Array [
Object {
"dependencies": Object {
"pkg-b": "2.0.0-20211213000730",
},
"name": "pkg-a",
"version": "1.0.0",
},
Object {
"name": "pkg-b",
"version": "2.0.0-20211213000730",
},
]
`);
} finally {
// eslint-disable-next-line no-global-assign
Date = originalDate;
}
});
});
});

Expand Down