Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Generate messages & requests codes list #33434

Closed
mrgrain opened this issue Feb 13, 2025 · 1 comment · Fixed by aws/aws-cdk-cli#44
Closed

Generate messages & requests codes list #33434

mrgrain opened this issue Feb 13, 2025 · 1 comment · Fixed by aws/aws-cdk-cli#44
Assignees
@kaizencc
Labels
@aws-cdk/core Related to core CDK functionality cli Issues related to the CDK CLI effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p1

Comments

@mrgrain
Copy link
Contributor

mrgrain commented Feb 13, 2025

Generate a markdown documentation page that includes all codes, descriptions and data types.

Goal a markdown file looking like this:

# Message Codes

## Backwards compat rules

## Deploy

| Code              | Desc                          | level  | data interface                              |
| ----------------- | ----------------------------- | ------ | ------------------------------------------- |
| CDK_TOOLKIT_I5900 | Deployment results on success | result | `{ ... }` [SuccessfulDeployStackResult](..) |
@pahud pahud added p1 @aws-cdk/core Related to core CDK functionality feature-request A feature should be added or improved. cli Issues related to the CDK CLI effort/medium Medium work item – several days of effort labels Feb 14, 2025
@kaizencc kaizencc mentioned this issue Feb 17, 2025
Merged
github-merge-queue bot pushed a commit to aws/aws-cdk-cli that referenced this issue Feb 25, 2025
@kaizencc @mrgrain
docs(toolkit-lib): CODE_REGISTRY.md tracks valid codes and their docu…
fdf54d0 
…mentation (#44)

closes aws/aws-cdk#33434

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

---------

Co-authored-by: Momo Kornher <kornherm@amazon.co.uk>
@github-actions GitHub Actions
Copy link

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 25, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@kaizencc kaizencc

Labels
@aws-cdk/core Related to core CDK functionality cli Issues related to the CDK CLI effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p1
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(toolkit-lib): CODE_REGISTRY.md tracks valid codes and their documentation aws/aws-cdk-cli
3 participants
@pahud @mrgrain @kaizencc