feat(cli): Support disabling version check

If AWS_CDK_DISABLE_VERSION_CHECK is defined, skip checking for newer versions. fixes #10974
aws · Oct 20, 2020 · 116428b · 116428b
1 parent dd81e77
commit 116428b
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 1 deletion.
diff --git a/packages/aws-cdk/README.md b/packages/aws-cdk/README.md
@@ -345,3 +345,9 @@ Some of the interesting keys that can be used in the JSON configuration files:
     "versionReporting": false,         // Opt-out of version reporting      (--no-version-reporting)
 }
 ```
+
+#### Environment
+
+The following environment variables affect aws-cdk:
+
+- `AWS_CDK_DISABLE_VERSION_CHECK`: If set, disable automatic check for newer versions.
diff --git a/packages/aws-cdk/lib/version.ts b/packages/aws-cdk/lib/version.ts
@@ -98,7 +98,7 @@ export async function latestVersionIfHigher(currentVersion: string, cacheFile: V
 }
 
 export async function displayVersionMessage(): Promise<void> {
-  if (!process.stdout.isTTY) {
+  if (!process.stdout.isTTY || process.env.AWS_CDK_DISABLE_VERSION_CHECK) {
     return;
   }
 

diff --git a/packages/aws-cdk/test/version.test.ts b/packages/aws-cdk/test/version.test.ts
@@ -72,3 +72,10 @@ test('No Version specified for storage in the TTL file', async () => {
   const storedVersion = fs.readFileSync(cacheFile, 'utf8');
   expect(storedVersion).toBe('');
 });
+
+test('Skip version check if environment variable is set', async () => {
+  process.env.AWS_CDK_DISABLE_VERSION_CHECK = '1';
+  const cache = new VersionCheckTTL(tmpfile(), 0);
+  await cache.update();
+  expect(await latestVersionIfHigher('0.0.0', cache)).toBeNull();
+});