[eas-cli] Use Git to pack Git projects #2841

sjchmiela · 2025-01-27T16:12:38Z

Why

Currently, when eas-cli create a project tarball for EAS Build or Workflows, unless the user has requireCommit: true in eas.json, the project is being packed with a plain makeShallowCopyAsync which copies all the files that are deemed ignored by ignore package and .easignore or .gitignore files.

This is suboptimal for eas workflow:run experience — a developer with a project with Git expects the repository to exist on EAS.

How

This was a big pain.

Previously, we had GitClient which required commit and its subclass, GitNoCommitClient which overrode some functions to allow uncommitted changes. On top of that, GitClient copied project with git clone, while GitNoCommitClient copied it with makeShallowCopyAsync. This meant GitClient's copy would include .git, whereas GitNoCommitClient would not. Moreover, thus, GitClient would adhere to .gitignore and GitNoCommitClient would not — only to .easignore.

This pull request:

merges the two Git clients into one with requireCommit option
this causes .git directory to exist in copies with requireCommit = false
changes how we log changes caused by Git case sensitivity change (we need to handle the case where there is a preexisting dirty tree)
after we clone the repository, we delete files that should have been ignored according to .easignore
afterwards, we make a shallow copy of all the files over to the clone. This copies live changes to the working tree over to the clean clone. (They may only exist in requireCommit = false situation.)
adds better support for .easignore to isFileIgnoredAsync.

As far as I can see the behavior looks like this:

The breaking change in here is that we're going to start adhering to .easignore even if someone has requireCommit = true.

Test Plan

I used easd build:inspect a bunch to verify it works like I expect. I encourage fellow reviewers to do the same.

linear · 2025-01-27T16:12:42Z

ENG-14846 Pack projects with Git in no-commit mode

…ojectSourceAsync.ts

github-actions · 2025-01-27T16:16:51Z

Size Change: -3.95 kB (-0.01%)

Total Size: 53.4 MB

Filename	Size	Change
`./packages/eas-cli/dist/eas-linux-x64.tar.gz`	53.4 MB	-3.95 kB (-0.01%)

_{compressed-size-action}

codecov · 2025-01-27T16:17:50Z

Codecov Report

Attention: Patch coverage is 8.92857% with 51 lines in your changes missing coverage. Please review.

Project coverage is 52.87%. Comparing base (b31ddee) to head (e01a830).
Report is 25 commits behind head on main.

Files with missing lines	Patch %	Lines
packages/eas-cli/src/vcs/clients/git.ts	4.26%	39 Missing and 6 partials ⚠️
packages/eas-cli/src/commands/build/internal.ts	33.34%	1 Missing and 1 partial ⚠️
packages/eas-cli/src/commands/submit/internal.ts	33.34%	1 Missing and 1 partial ⚠️
...ackages/eas-cli/src/commands/project/onboarding.ts	0.00%	1 Missing ⚠️
packages/eas-cli/src/vcs/index.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2841      +/-   ##
==========================================
+ Coverage   52.62%   52.87%   +0.26%     
==========================================
  Files         584      583       -1     
  Lines       22638    22647       +9     
  Branches     4707     4715       +8     
==========================================
+ Hits        11910    11973      +63     
+ Misses       9800     9741      -59     
- Partials      928      933       +5

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

github-actions · 2025-01-28T15:34:10Z

✅ Thank you for adding the changelog entry!

github-actions · 2025-01-28T15:57:38Z

Subscribed to pull request

File Patterns	Mentions
*/	@szdziedzic, @khamilowicz, @radoslawkrzemien

Generated by CodeMention

szdziedzic · 2025-01-30T09:20:18Z

packages/eas-cli/src/vcs/clients/git.ts

+    if (
+      uncommitedChangesAfterCaseSensitivityChange !== uncommittedChangesBeforeCaseSensitivityChange
+    ) {


what is the format of these 2? is there a chance that git will return files in different order causing us to enter this if statement even if nothing changed? maybe we should operate on sets here?

I assumed there is no chance that Git would return files in different order.

szdziedzic · 2025-01-30T09:22:16Z

packages/eas-cli/src/vcs/clients/git.ts

+  // that were marked as changed after the case sensitivity change.
+  const uncommittedChangesBeforeCaseSensitivityChange = await gitStatusAsync({
+    showUntracked: true,
+    cwd,


we are using rootPath as cwd for it here, but previously we used this.maybeCwdOverride

does this change matter?

rootPath is supposed to be root of the Git repository and should take maybeCwdOverride into consideration:

radoslawkrzemien

I think it looks good, but I'm not too familiar with this part of the codebase

szdziedzic

looks reasonable

This reverts commit 18bf417.

Use Git to pack Git projects

4455b10

sjchmiela added 2 commits January 27, 2025 17:13

Discard changes to packages/eas-cli/src/build/utils/repository.ts

af1bf1b

Discard changes to packages/eas-cli/src/project/uploadAccountScopedPr…

79d9063

…ojectSourceAsync.ts

Fixup

dd3ce1a

Fixup

d3e8dfb

sjchmiela force-pushed the stanley/eng-14846-pack-projects-with-git-in-no-commit-mode branch from e250482 to d3e8dfb Compare January 27, 2025 16:34

sjchmiela added 6 commits January 28, 2025 11:38

Fixup

40fff1a

Add changelog entry

fe84642

Fix requiring commit in EAS

cc04b63

Remove files we would have ignored by .easignore

cd9bf95

Fix isFileIgnoredAsync

8027e76

Fix submit:internal

e01a830

sjchmiela marked this pull request as ready for review January 28, 2025 15:57

sjchmiela requested review from szdziedzic and radoslawkrzemien January 28, 2025 15:57

szdziedzic reviewed Jan 30, 2025

View reviewed changes

radoslawkrzemien approved these changes Jan 30, 2025

View reviewed changes

sjchmiela requested a review from szdziedzic February 3, 2025 10:42

szdziedzic approved these changes Feb 3, 2025

View reviewed changes

sjchmiela merged commit 18bf417 into main Feb 4, 2025
11 checks passed

sjchmiela deleted the stanley/eng-14846-pack-projects-with-git-in-no-commit-mode branch February 4, 2025 09:13

szdziedzic added a commit that referenced this pull request Feb 4, 2025

Revert "[eas-cli] Use Git to pack Git projects (#2841)"

bf1c404

This reverts commit 18bf417.

szdziedzic mentioned this pull request Feb 4, 2025

Revert "[eas-cli] Use Git to pack Git projects" #2870

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[eas-cli] Use Git to pack Git projects #2841

[eas-cli] Use Git to pack Git projects #2841

sjchmiela commented Jan 27, 2025 •

edited

Loading

linear bot commented Jan 27, 2025

github-actions bot commented Jan 27, 2025 •

edited

Loading

codecov bot commented Jan 27, 2025 •

edited

Loading

github-actions bot commented Jan 28, 2025

github-actions bot commented Jan 28, 2025

szdziedzic Jan 30, 2025

sjchmiela Feb 3, 2025

szdziedzic Jan 30, 2025

sjchmiela Jan 30, 2025

radoslawkrzemien left a comment

szdziedzic left a comment

[eas-cli] Use Git to pack Git projects #2841

[eas-cli] Use Git to pack Git projects #2841

Conversation

sjchmiela commented Jan 27, 2025 • edited Loading

Why

How

Test Plan

linear bot commented Jan 27, 2025

github-actions bot commented Jan 27, 2025 • edited Loading

codecov bot commented Jan 27, 2025 • edited Loading

Codecov Report

github-actions bot commented Jan 28, 2025

github-actions bot commented Jan 28, 2025

szdziedzic Jan 30, 2025

Choose a reason for hiding this comment

sjchmiela Feb 3, 2025

Choose a reason for hiding this comment

szdziedzic Jan 30, 2025

Choose a reason for hiding this comment

sjchmiela Jan 30, 2025

Choose a reason for hiding this comment

radoslawkrzemien left a comment

Choose a reason for hiding this comment

szdziedzic left a comment

Choose a reason for hiding this comment

sjchmiela commented Jan 27, 2025 •

edited

Loading

github-actions bot commented Jan 27, 2025 •

edited

Loading

codecov bot commented Jan 27, 2025 •

edited

Loading