Skip to content

Commit 04ac50c

Browse files
kaizenccgithub-actions
and
github-actions
authored
docs(toolkit-lib): code registry links to public doc page (#161)
and `IoMessage` doc page links to code registry --- By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license --------- Signed-off-by: github-actions <[email protected]> Co-authored-by: github-actions <[email protected]>
1 parent f9e65cb commit 04ac50c

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

packages/@aws-cdk/toolkit-lib/CODE_REGISTRY.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@
33
| Code | Description | Level | Data Interface |
44
|------|-------------|-------|----------------|
55
| CDK_TOOLKIT_I1000 | Provides synthesis times. | info | n/a |
6-
| CDK_TOOLKIT_I1901 | Provides stack data | result | [StackData](docs/interfaces/StackData.html) |
7-
| CDK_TOOLKIT_I1902 | Successfully deployed stacks | result | [AssemblyData](docs/interfaces/AssemblyData.html) |
6+
| CDK_TOOLKIT_I1901 | Provides stack data | result | [StackData](https://docs.aws.amazon.com/cdk/api/toolkit-lib/interfaces/StackData.html) |
7+
| CDK_TOOLKIT_I1902 | Successfully deployed stacks | result | [AssemblyData](https://docs.aws.amazon.com/cdk/api/toolkit-lib/interfaces/AssemblyData.html) |
88
| CDK_TOOLKIT_I2901 | Provides details on the selected stacks and their dependencies | result | n/a |
99
| CDK_TOOLKIT_E3900 | Resource import failed | error | n/a |
1010
| CDK_TOOLKIT_I5000 | Provides deployment times | info | n/a |
11-
| CDK_TOOLKIT_I5001 | Provides total time in deploy action, including synth and rollback | info | [Duration](docs/interfaces/Duration.html) |
11+
| CDK_TOOLKIT_I5001 | Provides total time in deploy action, including synth and rollback | info | [Duration](https://docs.aws.amazon.com/cdk/api/toolkit-lib/interfaces/Duration.html) |
1212
| CDK_TOOLKIT_I5002 | Provides time for resource migration | info | n/a |
1313
| CDK_TOOLKIT_I5031 | Informs about any log groups that are traced as part of the deployment | info | n/a |
1414
| CDK_TOOLKIT_I5050 | Confirm rollback during deployment | info | n/a |
1515
| CDK_TOOLKIT_I5060 | Confirm deploy security sensitive changes | info | n/a |
16-
| CDK_TOOLKIT_I5900 | Deployment results on success | result | [SuccessfulDeployStackResult](docs/interfaces/SuccessfulDeployStackResult.html) |
16+
| CDK_TOOLKIT_I5900 | Deployment results on success | result | [SuccessfulDeployStackResult](https://docs.aws.amazon.com/cdk/api/toolkit-lib/interfaces/SuccessfulDeployStackResult.html) |
1717
| CDK_TOOLKIT_E5001 | No stacks found | error | n/a |
1818
| CDK_TOOLKIT_I6000 | Provides rollback times | info | n/a |
1919
| CDK_TOOLKIT_E6001 | No stacks found | error | n/a |

packages/@aws-cdk/toolkit-lib/lib/api/io/io-message.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { ToolkitAction } from '../../toolkit';
77
export type IoMessageLevel = 'error'| 'result' | 'warn' | 'info' | 'debug' | 'trace';
88

99
/**
10-
* A valid message code
10+
* A valid message code. See https://github.com/aws/aws-cdk-cli/blob/main/packages/%40aws-cdk/toolkit-lib/CODE_REGISTRY.md
1111
*/
1212
export type IoMessageCode = `CDK_${string}_${'E' | 'W' | 'I'}${number}${number}${number}${number}`;
1313

packages/@aws-cdk/toolkit-lib/scripts/gen-code-registry.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ function codesToMarkdownTable(codes: Record<string, CodeInfo>, mdPrefix?: string
1919
}
2020

2121
function linkInterface(interfaceName: string) {
22-
const docSite = 'docs/interfaces/';
22+
const docSite = 'https://docs.aws.amazon.com/cdk/api/toolkit-lib/interfaces/';
2323
return `[${interfaceName}](${docSite}${interfaceName}.html)`;
2424
}
2525

0 commit comments

Comments
 (0)