docs(toolkit-lib): CODE_REGISTRY.md tracks valid codes and their documentation by kaizencc · Pull Request #44 · aws/aws-cdk-cli

kaizencc · 2025-02-17T22:29:17Z

generates CODE_REGISTRY.md using information gathered in codes.ts. this pr:

updates codes.ts to have additional information stored
introduces a script that generates a markdown table from the CODES object
updates projen to build CODE_REGISTRY.md as a post-build step

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

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

kaizencc · 2025-02-17T22:30:16Z

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

@@ -0,0 +1,29 @@
+| Code | Description | Level | Data Interface |
+|------|-------------| ----- | -------------- |
+| CDK_TOOLKIT_I1000 | Provides synthesis times. | info | undefined |


the real interesting stuff is in the Data Interface section, which I haven't approached yet

mrgrain · 2025-02-18T13:40:33Z

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

@@ -0,0 +1,29 @@
+| Code | Description | Level | Data Interface |
+|------|-------------| ----- | -------------- |
+| CDK_TOOLKIT_I1000 | Provides synthesis times. | info | undefined |


probably n/a if no data is send

mrgrain

This is the right direction I think.

One think I'm going to be interested in is how we can soft-enforce to correct level and data structure when using codes. Would love to see your ideas for that.

kaizencc · 2025-02-20T23:22:30Z

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

+| 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) |


doc pages aren't committed so i don't know exactly what to do here

I think we can link to the public page once it's available.

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

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

kaizencc · 2025-02-20T23:24:30Z

packages/@aws-cdk/toolkit-lib/lib/toolkit/types.ts

if you're ok with me naming and exposing these values here, then I will add docstrings. I'm also not sure what to do with successfuldeploystackresult because we are using that interface from aws-cdk so it otherwise doesn't show up in the generated docs

kaizencc · 2025-02-20T23:54:08Z

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

 * Creates an info level message.
 */
-export const info = <T>(message: string, code?: VALID_CODE, payload?: T) => {
+export const info = <T>(message: string, code?: CodeInfo, payload?: T) => {


i forgot how we said we wanted to soft enforce that we call info on a code with level info. can you jog my memory @mrgrain ?

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

mrgrain · 2025-02-24T12:31:28Z

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

+  Object.values(codes).forEach((code) => {
+    table += `| ${code.code} | ${code.description} | ${code.level} | ${code.interface ? linkInterface(code.interface) : 'n/a'} |\n`;
+  });


I think we can check here that the key and code are the same and otherwise throw

Co-authored-by: Momo Kornher <kornherm@amazon.co.uk>

codecov-commenter · 2025-02-24T14:51:10Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.51%. Comparing base (757ae69) to head (c75884f).
Report is 345 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #44      +/-   ##
==========================================
- Coverage   84.57%   84.51%   -0.06%     
==========================================
  Files         196      196              
  Lines       35187    35187              
  Branches     4522     4524       +2     
==========================================
- Hits        29760    29740      -20     
- Misses       5281     5301      +20     
  Partials      146      146

Flag	Coverage Δ
suite.unit	`84.51% <ø> (-0.06%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

kaizencc had a problem deploying to integ-approval February 17, 2025 22:29 — with GitHub Actions Failure

aws-cdk-automation enabled auto-merge February 17, 2025 22:29

kaizencc had a problem deploying to integ-approval February 17, 2025 22:31 — with GitHub Actions Failure

kaizencc commented Feb 17, 2025

View reviewed changes

mrgrain reviewed Feb 18, 2025

View reviewed changes

kaizencc had a problem deploying to integ-approval February 18, 2025 15:17 — with GitHub Actions Failure

kaizencc had a problem deploying to integ-approval February 18, 2025 15:18 — with GitHub Actions Failure

kaizencc had a problem deploying to integ-approval February 18, 2025 18:31 — with GitHub Actions Failure

kaizencc had a problem deploying to integ-approval February 18, 2025 21:32 — with GitHub Actions Failure

kaizencc force-pushed the conroy/markdown branch from 262b4b6 to b08ec0e Compare February 18, 2025 21:33

kaizencc had a problem deploying to integ-approval February 18, 2025 21:33 — with GitHub Actions Failure

kaizencc added 8 commits February 20, 2025 12:02

update codes

41c4334

merge?

3d93b6c

no prepend necessary

4117622

pass n/a

2b62a97

wip

6a80121

add prefix/postfix option to code registry

fe179cb

wip -- revert to this if needed

f005b70

wip

1d4833f

kaizencc force-pushed the conroy/markdown branch from b08ec0e to 1d4833f Compare February 20, 2025 17:04

kaizencc had a problem deploying to integ-approval February 20, 2025 17:04 — with GitHub Actions Failure

code registry links to docs site thats not committed

5fe905e

kaizencc had a problem deploying to integ-approval February 20, 2025 19:57 — with GitHub Actions Failure

more changes

add7c77

kaizencc had a problem deploying to integ-approval February 20, 2025 23:22 — with GitHub Actions Failure

kaizencc commented Feb 20, 2025

View reviewed changes

Update packages/@aws-cdk/toolkit-lib/lib/api/io/private/codes.ts

bd57fd7

kaizencc had a problem deploying to integ-approval February 20, 2025 23:25 — with GitHub Actions Failure

Update packages/@aws-cdk/toolkit-lib/lib/api/io/private/messages.ts

88ccc7d

kaizencc had a problem deploying to integ-approval February 20, 2025 23:26 — with GitHub Actions Failure

Merge branch 'main' into conroy/markdown

99b2378

kaizencc had a problem deploying to integ-approval February 20, 2025 23:26 — with GitHub Actions Failure

kaizencc commented Feb 20, 2025

View reviewed changes

mrgrain reviewed Feb 24, 2025

View reviewed changes

packages/@aws-cdk/toolkit-lib/scripts/gen-code-registry.ts Outdated Show resolved Hide resolved

mrgrain reviewed Feb 24, 2025

View reviewed changes

Merge branch 'main' into conroy/markdown

c2df233

kaizencc had a problem deploying to integ-approval February 24, 2025 14:42 — with GitHub Actions Failure

Apply suggestions from code review

aac453a

Co-authored-by: Momo Kornher <kornherm@amazon.co.uk>

kaizencc had a problem deploying to integ-approval February 24, 2025 14:43 — with GitHub Actions Failure

kaizencc changed the title ~~docs(toolkit): CODE_REGISTRY.md tracks valid codes and their documentation~~ docs(toolkit-lib): CODE_REGISTRY.md tracks valid codes and their documentation Feb 24, 2025

pr feedback and build works

6684f5a

kaizencc had a problem deploying to integ-approval February 24, 2025 16:13 — with GitHub Actions Failure

documentation

fc551f6

kaizencc had a problem deploying to integ-approval February 24, 2025 16:27 — with GitHub Actions Failure

mrgrain approved these changes Feb 24, 2025

View reviewed changes

mrgrain disabled auto-merge February 24, 2025 18:51

rix0rrr added the pr/exempt-integ-test Skips the integ test steps if set. label Feb 25, 2025

rix0rrr marked this pull request as draft February 25, 2025 08:48

rix0rrr marked this pull request as ready for review February 25, 2025 08:48

aws-cdk-automation enabled auto-merge February 25, 2025 08:49

Merge branch 'main' into conroy/markdown

c75884f

aws-cdk-automation added this pull request to the merge queue Feb 25, 2025

Merged via the queue into main with commit fdf54d0 Feb 25, 2025
11 checks passed

aws-cdk-automation deleted the conroy/markdown branch February 25, 2025 18:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(toolkit-lib): CODE_REGISTRY.md tracks valid codes and their documentation#44

docs(toolkit-lib): CODE_REGISTRY.md tracks valid codes and their documentation#44
aws-cdk-automation merged 18 commits intomainfrom
conroy/markdown

kaizencc commented Feb 17, 2025 •

edited

Loading

Uh oh!

Uh oh!

kaizencc Feb 17, 2025

Uh oh!

mrgrain Feb 18, 2025

Uh oh!

mrgrain left a comment •

edited

Loading

Uh oh!

kaizencc Feb 20, 2025

Uh oh!

mrgrain Feb 24, 2025

Uh oh!

Uh oh!

Uh oh!

kaizencc Feb 20, 2025

Uh oh!

kaizencc Feb 20, 2025

Uh oh!

Uh oh!

mrgrain Feb 24, 2025

Uh oh!

codecov-commenter commented Feb 24, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

kaizencc commented Feb 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

kaizencc Feb 17, 2025

Choose a reason for hiding this comment

Uh oh!

mrgrain Feb 18, 2025

Choose a reason for hiding this comment

Uh oh!

mrgrain left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kaizencc Feb 20, 2025

Choose a reason for hiding this comment

Uh oh!

mrgrain Feb 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

kaizencc Feb 20, 2025

Choose a reason for hiding this comment

Uh oh!

kaizencc Feb 20, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mrgrain Feb 24, 2025

Choose a reason for hiding this comment

Uh oh!

codecov-commenter commented Feb 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

kaizencc commented Feb 17, 2025 •

edited

Loading

mrgrain left a comment •

edited

Loading

codecov-commenter commented Feb 24, 2025 •

edited

Loading