From 04ac50c8940c5a8f4e2d107f6480c7cd07544795 Mon Sep 17 00:00:00 2001 From: Kaizen Conroy <36202692+kaizencc@users.noreply.github.com> Date: Thu, 27 Feb 2025 03:32:15 -0500 Subject: [PATCH] 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 Co-authored-by: github-actions --- packages/@aws-cdk/toolkit-lib/CODE_REGISTRY.md | 8 ++++---- packages/@aws-cdk/toolkit-lib/lib/api/io/io-message.ts | 2 +- .../@aws-cdk/toolkit-lib/scripts/gen-code-registry.ts | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/@aws-cdk/toolkit-lib/CODE_REGISTRY.md b/packages/@aws-cdk/toolkit-lib/CODE_REGISTRY.md index c5c65d2c..220144b0 100644 --- a/packages/@aws-cdk/toolkit-lib/CODE_REGISTRY.md +++ b/packages/@aws-cdk/toolkit-lib/CODE_REGISTRY.md @@ -3,17 +3,17 @@ | Code | Description | Level | Data Interface | |------|-------------|-------|----------------| | CDK_TOOLKIT_I1000 | Provides synthesis times. | info | n/a | -| CDK_TOOLKIT_I1901 | Provides stack data | result | [StackData](docs/interfaces/StackData.html) | -| CDK_TOOLKIT_I1902 | Successfully deployed stacks | result | [AssemblyData](docs/interfaces/AssemblyData.html) | +| CDK_TOOLKIT_I1901 | Provides stack data | result | [StackData](https://docs.aws.amazon.com/cdk/api/toolkit-lib/interfaces/StackData.html) | +| CDK_TOOLKIT_I1902 | Successfully deployed stacks | result | [AssemblyData](https://docs.aws.amazon.com/cdk/api/toolkit-lib/interfaces/AssemblyData.html) | | CDK_TOOLKIT_I2901 | Provides details on the selected stacks and their dependencies | result | n/a | | CDK_TOOLKIT_E3900 | Resource import failed | error | n/a | | CDK_TOOLKIT_I5000 | Provides deployment times | info | n/a | -| CDK_TOOLKIT_I5001 | Provides total time in deploy action, including synth and rollback | info | [Duration](docs/interfaces/Duration.html) | +| 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) | | CDK_TOOLKIT_I5002 | Provides time for resource migration | info | n/a | | CDK_TOOLKIT_I5031 | Informs about any log groups that are traced as part of the deployment | info | n/a | | CDK_TOOLKIT_I5050 | Confirm rollback during deployment | info | n/a | | CDK_TOOLKIT_I5060 | Confirm deploy security sensitive changes | info | n/a | -| CDK_TOOLKIT_I5900 | Deployment results on success | result | [SuccessfulDeployStackResult](docs/interfaces/SuccessfulDeployStackResult.html) | +| CDK_TOOLKIT_I5900 | Deployment results on success | result | [SuccessfulDeployStackResult](https://docs.aws.amazon.com/cdk/api/toolkit-lib/interfaces/SuccessfulDeployStackResult.html) | | CDK_TOOLKIT_E5001 | No stacks found | error | n/a | | CDK_TOOLKIT_I6000 | Provides rollback times | info | n/a | | CDK_TOOLKIT_E6001 | No stacks found | error | n/a | diff --git a/packages/@aws-cdk/toolkit-lib/lib/api/io/io-message.ts b/packages/@aws-cdk/toolkit-lib/lib/api/io/io-message.ts index fcfef497..b4d70939 100644 --- a/packages/@aws-cdk/toolkit-lib/lib/api/io/io-message.ts +++ b/packages/@aws-cdk/toolkit-lib/lib/api/io/io-message.ts @@ -7,7 +7,7 @@ import { ToolkitAction } from '../../toolkit'; export type IoMessageLevel = 'error'| 'result' | 'warn' | 'info' | 'debug' | 'trace'; /** - * A valid message code + * A valid message code. See https://github.com/aws/aws-cdk-cli/blob/main/packages/%40aws-cdk/toolkit-lib/CODE_REGISTRY.md */ export type IoMessageCode = `CDK_${string}_${'E' | 'W' | 'I'}${number}${number}${number}${number}`; diff --git a/packages/@aws-cdk/toolkit-lib/scripts/gen-code-registry.ts b/packages/@aws-cdk/toolkit-lib/scripts/gen-code-registry.ts index 935efee8..c461fc62 100644 --- a/packages/@aws-cdk/toolkit-lib/scripts/gen-code-registry.ts +++ b/packages/@aws-cdk/toolkit-lib/scripts/gen-code-registry.ts @@ -19,7 +19,7 @@ function codesToMarkdownTable(codes: Record, mdPrefix?: string } function linkInterface(interfaceName: string) { - const docSite = 'docs/interfaces/'; + const docSite = 'https://docs.aws.amazon.com/cdk/api/toolkit-lib/interfaces/'; return `[${interfaceName}](${docSite}${interfaceName}.html)`; }