✨ Skip github update check if PERCY_SKIP_UPDATE_CHECK is truthy (#1127

) * ✨ skip github update check if `PERCY_SKIP_UPDATE_CHECK` is truthy * allow any truthy value * test for PERCY_SKIP_UPDATE_CHECK Co-authored-by: Samarjeet <[email protected]>
percy · Nov 10, 2022 · 65c8442 · 65c8442
1 parent d2e812d
commit 65c8442
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/packages/cli/src/update.js b/packages/cli/src/update.js
@@ -69,6 +69,11 @@ export async function checkForUpdate() {
   let pkg = getPackageJSON(import.meta.url);
   let log = logger('cli:update');
 
+  if (process.env.PERCY_SKIP_UPDATE_CHECK) {
+    log.debug('Skipping update check');
+    return;
+  }
+
   try {
     // request new release information if needed
     if (!releases) {

diff --git a/packages/cli/test/update.test.js b/packages/cli/test/update.test.js
@@ -37,6 +37,20 @@ describe('CLI update check', () => {
     expect(ghAPI).not.toHaveBeenCalled();
   });
 
+  it('does not fetch the latest release information if PERCY_SKIP_UPDATE_CHECK is present', async () => {
+    expect(fs.existsSync('.releases')).toBe(false);
+    process.env.PERCY_SKIP_UPDATE_CHECK = 1;
+
+    logger.loglevel('debug');
+
+    await checkForUpdate();
+    expect(logger.stdout).toEqual([]);
+    expect(logger.stderr).toEqual(['[percy:cli:update] Skipping update check']);
+    expect(ghAPI).not.toHaveBeenCalled();
+
+    delete process.env.PERCY_SKIP_UPDATE_CHECK;
+  });
+
   it('fetchs the latest release information if the cache is outdated', async () => {
     ghAPI.and.returnValue([200, [{ tag_name: 'v1.0.0' }]]);