fix(git): wrong changeset file commit - #2277

🦋 Changeset detected

Latest commit: ead294f

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

✅ Deploy Preview for changesets ready!

Name	Link
🔨 Latest commit	ead294f
🔍 Latest deploy log	https://app.netlify.com/projects/changesets/deploys/6a96b382fa8a4500080b9d6a
😎 Deploy Preview	https://deploy-preview-2277--changesets.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.57%. Comparing base (a0a4dc6) to head (ead294f).
⚠️ Report is 3 commits behind head on main.

@@           Coverage Diff           @@
##             main    #2277   +/-   ##
=======================================
  Coverage   84.57%   84.57%           
=======================================
  Files          80       80           
  Lines        3177     3177           
  Branches      894      894           
=======================================
  Hits         2687     2687           
  Misses        433      433           
  Partials       57       57           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

This PR also fixes another issue by adding the -- separator to the git log command to tell git to look for the history of a deleted file (because before this command runs, the version command has already deleted the changeset files in the checkout project).

Can you elaborate on this? We should be capturing the commits first before deleting the files. With the -- flag it looks like it can match files not in the current branch, which we only want to match on the current branch.

Can you elaborate on this? We should be capturing the commits first before deleting the files.

Ah true, I confused the method order. Nonetheless, I strongly recommend using the -- separator to prevent confusion with other parameters, as the docs mention.

With the -- flag it looks like it can match files not in the current branch, which we only want to match on the current branch.

Where exactly does it mention this?

Where exactly does it mention this?

I tested it manually. If you delete README.md for example, if you do git log README.md, it fails. But if git log -- README.md it passes.

When it fails, it also logs this which kinda explains it ("path not in the working tree"):

fatal: ambiguous argument 'README.md': unknown revision or path not in the working tree.
Use '--' to separate paths from revisions, like this:
'git <command> [<revision>...] -- [<file>...]'

I tested it manually. If you delete README.md for example, if you do git log README.md, it fails. But if git log -- README.md it passes.

When it fails, it also logs this which kinda explains it ("path not in the working tree"):

fatal: ambiguous argument 'README.md': unknown revision or path not in the working tree.
Use '--' to separate paths from revisions, like this:
'git <command> [<revision>...] -- [<file>...]'

Gotcha. I think the error happens because git doesn't fully understand that we want to pass the path argument (as the file doesn't exist). It interpretes our path as a revision, but this is no revision. So adding -- makes sure that git always knows it's a path.

I initially included it because I also thought that the command would fail with the error you showed. However, since we get the commits before deleting, I think it isn't strictly necessarily to include the -- separator currently. It is just more fragile if we don't include it.

So IMHO we should keep the -- separator, but im also open to removing it 👍

I'd prefer removing -- so the command only works on paths in the current working tree. If you prefer to use --, we need a flag or something that makes sure to only return if the path exists in the current working tree. If there's no way to do that, we should remove --.

I removed it for now because if you use --, git searches the commits even when the file was deleted (outside of current working tree). However, one potential problem without the separator is: If a branch exists with the exact name of the path we pass, git would show the history of the branch instead of the path. This is very unlikely I think because I never saw some branch name that includes .md. Nonetheless, it's worth considering. But removing it is fine for me, so this PR focuses on the actual bug only 👍