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.

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

Jump to bottom

Get correct absolute path of changed files when .changeset/ is not in the root of the repository #770

Merged
merged 7 commits into from
Mar 13, 2022
Merged

Get correct absolute path of changed files when .changeset/ is not in the root of the repository #770

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
96095b8
Get repository root instead of `cwd`
alizeait Mar 5, 2022
6b7f290
Create silly-sloths-brush.md
alizeait Mar 5, 2022
2c36da3
Add full path test case
alizeait Mar 6, 2022
a7ed53d
Merge branch 'fix-changed-since-absolute-path' of github.com:alizeait…
alizeait Mar 6, 2022
adc0087
Update .changeset/silly-sloths-brush.md
alizeait Mar 12, 2022
a5ac08a
Add `@changesets/cli` changeset
alizeait Mar 12, 2022
08770b0
Throw instead of returning `cwd`
alizeait Mar 13, 2022
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
5 changes: 5 additions & 0 deletions .changeset/sharp-tools-yell.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@changesets/cli": patch
---

`changeset add` and `changeset status` should now properly handle the situation where Changesets are managed from a directory different than the root of the repository.
5 changes: 5 additions & 0 deletions .changeset/silly-sloths-brush.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@changesets/git": patch
---

`getChangedFilesSince` and `getChangedPackagesSinceRef` will now return the correct absolute paths of the changed files when the passed `cwd` is different from the repository's root.
34 changes: 34 additions & 0 deletions packages/git/src/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import path from "path";
import fixtures from "fixturez";
import spawn from "spawndamnit";
import fileUrl from "file-url";
Expand Down Expand Up @@ -416,6 +417,39 @@ describe("git", () => {
"packages/pkg-b/package.json"
);
});
it("should get correct full paths of changed files irrespective of cwd", async () => {
const ref = await spawn("git", ["rev-parse", "HEAD"], { cwd });

await add("packages/pkg-a/index.js", cwd);
await commit("Add packageA index", cwd);

await add("packages/pkg-b/index.js", cwd);
await commit("Added packageB index", cwd);

const filesChangedSinceRef = await getChangedFilesSince({
ref: ref.stdout.toString().trim(),
cwd,
fullPath: true
});
expect(filesChangedSinceRef[0]).toBe(
path.resolve(cwd, "packages/pkg-a/index.js")
);
expect(filesChangedSinceRef[1]).toBe(
path.resolve(cwd, "packages/pkg-b/index.js")
);

const filesChangedSinceRef2 = await getChangedFilesSince({
ref: ref.stdout.toString().trim(),
cwd: path.resolve(cwd, "packages"),
fullPath: true
});
expect(filesChangedSinceRef2[0]).toBe(
path.resolve(cwd, "packages/pkg-a/index.js")
);
expect(filesChangedSinceRef2[1]).toBe(
path.resolve(cwd, "packages/pkg-b/index.js")
);
});
});

describe("getChangedPackagesSinceRef", () => {
Expand Down
20 changes: 19 additions & 1 deletion packages/git/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,22 @@ export async function isRepoShallow({ cwd }: { cwd: string }) {
export async function deepenCloneBy({ by, cwd }: { by: number; cwd: string }) {
await spawn("git", ["fetch", `--deepen=${by}`], { cwd });
}
async function getRepoRoot({ cwd }: { cwd: string }) {
const { stdout, code } = await spawn(
"git",
["rev-parse", "--show-toplevel"],
{ cwd }
);

if (code !== 0) {
return cwd;
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a defensive check or perhaps this can sometimes happen for some legitimate reason?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I doubt It'll fail, but if it does, fallback to the previous behavior

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

according to the docs:

Show the (by default, absolute) path of the top-level directory of the working tree. If there is no working tree, report an error.

So I think that we should throw an error here:

Suggested change
if (code !== 0) {
return cwd;
}
if (code !== 0) {
throw new Error(gitCmd.stderr.toString());
}

Where for us this actually shouldn't ever throw, but this function is quite generic - so if we ever expose it then somebody could call it with cwd outside of a git repo.

I think that it's better to throw here to raise potential issues early, rather than to swallow the error and lead to undetermined behavior.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds reasonable


return stdout
.toString()
.trim()
.replace(/\n|\r/g, "");
}

export async function getChangedFilesSince({
cwd,
Expand All @@ -207,7 +223,9 @@ export async function getChangedFilesSince({
.split("\n")
.filter(a => a);
if (!fullPath) return files;
return files.map(file => path.resolve(cwd, file));

const repoRoot = await getRepoRoot({ cwd });
return files.map(file => path.resolve(repoRoot, file));
}

// below are less generic functions that we use in combination with other things we are doing
Expand Down