[PER-2582] Do not execute git commands when PERCY_SKIP_GIT_CHECK is…

… set to True (#1400)
percy · Oct 18, 2023 · da60154 · da60154
1 parent 932d9ce
commit da60154
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/packages/env/src/utils.js b/packages/env/src/utils.js
@@ -13,6 +13,9 @@ const GIT_COMMIT_FORMAT = [
 ].join('%n'); // git show format uses %n for newlines.
 
 export function git(args) {
+  if (process.env.PERCY_SKIP_GIT_CHECK === 'true') {
+    return '';
+  }
   try {
     return cp.execSync(`git ${args}`, {
       stdio: ['ignore', 'pipe', 'ignore'],

diff --git a/packages/env/test/defaults.test.js b/packages/env/test/defaults.test.js
@@ -171,4 +171,20 @@ describe('Defaults', () => {
 
     expect(env).toHaveProperty('git.sha', null);
   });
+
+  describe('env PERCY_SKIP_GIT_CHECK', () => {
+    beforeEach(() => {
+      process.env.PERCY_SKIP_GIT_CHECK = true;
+    });
+
+    afterAll(() => {
+      process.env.PERCY_SKIP_GIT_CHECK = false;
+    });
+
+    it('does not make git commands when set to true', () => {
+      mockgit('mock branch').and.returnValue('');
+
+      expect(env).toHaveProperty('git.sha', null);
+    });
+  });
 });