Skip to content

Commit 96fda68

Browse files
authored
chore(cli): update link for cli-telemetry --status (#932)
now that the doc page is live, it is a more official source of information than the github readme page. --- By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license
1 parent 8758f3c commit 96fda68

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

packages/@aws-cdk-testing/cli-integ/tests/cli-integ-tests/cli-telemetry/cdk-cli-telemetry-reports-status.integtest.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ integTest(
1111
try {
1212
// default status is enabled
1313
const output1 = await fixture.cdk(['cli-telemetry', '--status']);
14-
expect(output1).toContain('CLI Telemetry is enabled. See https://github.com/aws/aws-cdk-cli/tree/main/packages/aws-cdk#cdk-cli-telemetry for ways to disable.');
14+
expect(output1).toContain('CLI Telemetry is enabled. See https://docs.aws.amazon.com/cdk/v2/guide/cli-telemetry.html for ways to disable.');
1515

1616
// disable status
1717
await fs.writeFile(userContextFile, JSON.stringify({ context: { 'cli-telemetry': false } }));
1818
const output2 = await fixture.cdk(['cli-telemetry', '--status']);
19-
expect(output2).toContain('CLI Telemetry is disabled. See https://github.com/aws/aws-cdk-cli/tree/main/packages/aws-cdk#cdk-cli-telemetry for ways to enable.');
19+
expect(output2).toContain('CLI Telemetry is disabled. See https://docs.aws.amazon.com/cdk/v2/guide/cli-telemetry.html for ways to enable.');
2020
} finally {
2121
await fs.unlink(userContextFile);
2222
}

packages/aws-cdk/lib/cli/cdk-toolkit.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -210,9 +210,9 @@ export class CdkToolkit {
210210
const args = { ['version-reporting']: versionReporting };
211211
const canCollect = canCollectTelemetry(args, this.props.configuration.context);
212212
if (canCollect) {
213-
await this.ioHost.asIoHelper().defaults.info('CLI Telemetry is enabled. See https://github.com/aws/aws-cdk-cli/tree/main/packages/aws-cdk#cdk-cli-telemetry for ways to disable.');
213+
await this.ioHost.asIoHelper().defaults.info('CLI Telemetry is enabled. See https://docs.aws.amazon.com/cdk/v2/guide/cli-telemetry.html for ways to disable.');
214214
} else {
215-
await this.ioHost.asIoHelper().defaults.info('CLI Telemetry is disabled. See https://github.com/aws/aws-cdk-cli/tree/main/packages/aws-cdk#cdk-cli-telemetry for ways to enable.');
215+
await this.ioHost.asIoHelper().defaults.info('CLI Telemetry is disabled. See https://docs.aws.amazon.com/cdk/v2/guide/cli-telemetry.html for ways to enable.');
216216
}
217217
}
218218

packages/aws-cdk/test/commands/telemetry.test.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ describe('telemetry command', () => {
4646
await toolkit.cliTelemetryStatus();
4747

4848
// THEN
49-
expect(notifySpy).toHaveBeenCalledWith(expect.objectContaining({ level: 'info', message: 'CLI Telemetry is enabled. See https://github.com/aws/aws-cdk-cli/tree/main/packages/aws-cdk#cdk-cli-telemetry for ways to disable.' }));
49+
expect(notifySpy).toHaveBeenCalledWith(expect.objectContaining({ level: 'info', message: 'CLI Telemetry is enabled. See https://docs.aws.amazon.com/cdk/v2/guide/cli-telemetry.html for ways to disable.' }));
5050
});
5151

5252
test('status reports current telemetry status -- enabled intentionally', async () => {
@@ -55,7 +55,7 @@ describe('telemetry command', () => {
5555
await toolkit.cliTelemetryStatus();
5656

5757
// THEN
58-
expect(notifySpy).toHaveBeenCalledWith(expect.objectContaining({ level: 'info', message: 'CLI Telemetry is enabled. See https://github.com/aws/aws-cdk-cli/tree/main/packages/aws-cdk#cdk-cli-telemetry for ways to disable.' }));
58+
expect(notifySpy).toHaveBeenCalledWith(expect.objectContaining({ level: 'info', message: 'CLI Telemetry is enabled. See https://docs.aws.amazon.com/cdk/v2/guide/cli-telemetry.html for ways to disable.' }));
5959
});
6060

6161
test('status reports current telemetry status -- disabled via context', async () => {
@@ -64,7 +64,7 @@ describe('telemetry command', () => {
6464
await toolkit.cliTelemetryStatus();
6565

6666
// THEN
67-
expect(notifySpy).toHaveBeenCalledWith(expect.objectContaining({ level: 'info', message: 'CLI Telemetry is disabled. See https://github.com/aws/aws-cdk-cli/tree/main/packages/aws-cdk#cdk-cli-telemetry for ways to enable.' }));
67+
expect(notifySpy).toHaveBeenCalledWith(expect.objectContaining({ level: 'info', message: 'CLI Telemetry is disabled. See https://docs.aws.amazon.com/cdk/v2/guide/cli-telemetry.html for ways to enable.' }));
6868
});
6969

7070
test('status reports current telemetry status -- disabled via env var', async () => {
@@ -73,7 +73,7 @@ describe('telemetry command', () => {
7373
await toolkit.cliTelemetryStatus();
7474

7575
// THEN
76-
expect(notifySpy).toHaveBeenCalledWith(expect.objectContaining({ level: 'info', message: 'CLI Telemetry is disabled. See https://github.com/aws/aws-cdk-cli/tree/main/packages/aws-cdk#cdk-cli-telemetry for ways to enable.' }));
76+
expect(notifySpy).toHaveBeenCalledWith(expect.objectContaining({ level: 'info', message: 'CLI Telemetry is disabled. See https://docs.aws.amazon.com/cdk/v2/guide/cli-telemetry.html for ways to enable.' }));
7777
}, {
7878
CDK_DISABLE_CLI_TELEMETRY: 'true',
7979
});

0 commit comments

Comments
 (0)