refactor(cli): generate yargs configuration from TS by comcalvi · Pull Request #31850 · aws/aws-cdk

comcalvi · 2024-10-22T17:00:18Z

Issue # (if applicable)

N/A

Reason for this change

We'd like to create a programmatic interface to the CDK Toolkit. A bonus of this overhaul is moving to a single source of truth for both the programmatic interface to the CDK Toolkit and the command line interface to the CDK Toolkit. This PR generates the existing yargs configuration from a TS configuration. In the long term, we'd generate the yargs configuration purely from the programmatic interface to the Toolkit, but this is an improvement with less effort.

Description of changes

Creates a new package, @aws-cdk/yargs-gen, which generates our yargs configuration from a CliConfig defined in aws-cdk/config.ts using @cdklabs/typewriter.

Description of how you validated changes

N/A yet.

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

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

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

…m our standard build to not break something

:

mrgrain · 2024-10-23T13:56:27Z

I'm a inclined the check the generated code in for visibility and reviewability. WDYT?

comcalvi · 2024-10-23T21:15:34Z

My first instinct was to follow the codegen pattern we have for L1s, which is to ignore them, but the nature of the yargs code is very different from that of the L1s, so I agree that checking this file in is good. I've added it.

packages/aws-cdk/bin/yargs-gen

aws-cdk-automation · 2024-11-04T17:34:37Z

➡️ PR build request submitted to test-main-pipeline ⬅️

A maintainer must now check the pipeline and add the pr-linter/cli-integ-tested label once the pipeline succeeds.

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

aws-cdk-automation · 2024-11-05T12:19:48Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: f7a09b0
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2024-11-05T12:20:16Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

github-actions · 2024-11-05T12:20:39Z

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.

comcalvi added 8 commits October 14, 2024 12:33

init

637d5a9

prototype

3097ee5

args fix + the yargs inline function for the options is still wrong

e3b3d61

middleware + more options

19e92a3

docstring

8e0421b

all commands + options, missing epilogue + preamble still

8ca3812

working w/parameters

7c04ce0

comment

13c60eb

github-actions bot added the p2 label Oct 22, 2024

aws-cdk-automation requested a review from a team October 22, 2024 17:00

comcalvi changed the title ~~Comcalvi/cli yargs code gen~~ feat (CLI): generate yargs arguments from a TS configuration Oct 22, 2024

comcalvi changed the title ~~feat (CLI): generate yargs arguments from a TS configuration~~ feat (CLI): generate yargs configuration from TS Oct 22, 2024

mergify bot added the contribution/core This is a PR that came from AWS. label Oct 22, 2024

comcalvi mentioned this pull request Oct 22, 2024

feat: allow free function exports in typewriter cdklabs/awscdk-service-spec#1379

Merged

comcalvi had a problem deploying to test-pipeline October 22, 2024 17:01 — with GitHub Actions Failure

aws-cdk-automation previously requested changes Oct 22, 2024

View reviewed changes

aws-cdk-automation added the pr/needs-cli-test-run This PR needs CLI tests run against it. label Oct 22, 2024

comcalvi added 2 commits October 22, 2024 11:36

console

4740b49

move to the CLI...using ts-node is probably too large a deviation fro…

37c55ee

…m our standard build to not break something

comcalvi had a problem deploying to test-pipeline October 22, 2024 23:02 — with GitHub Actions Failure

comments

5353bb7

:

comcalvi had a problem deploying to test-pipeline October 22, 2024 23:22 — with GitHub Actions Failure

var-naming

814e36f

comcalvi had a problem deploying to test-pipeline October 22, 2024 23:49 — with GitHub Actions Failure

un-ignore

545128c

comcalvi had a problem deploying to test-pipeline October 23, 2024 21:15 — with GitHub Actions Failure

\n

869765b

comcalvi had a problem deploying to test-pipeline October 23, 2024 21:17 — with GitHub Actions Failure

mrgrain reviewed Oct 31, 2024

View reviewed changes

packages/aws-cdk/bin/yargs-gen Show resolved Hide resolved

comcalvi added 2 commits November 1, 2024 08:40

scripts dir

b0cb288

fixed the middleware

72759ca

comcalvi had a problem deploying to test-pipeline November 1, 2024 20:06 — with GitHub Actions Failure

Merge branch 'main' into comcalvi/cli-yargs-code-gen

d677a02

mrgrain temporarily deployed to test-pipeline November 4, 2024 17:31 — with GitHub Actions Inactive

mrgrain changed the title ~~feat(CLI): generate yargs configuration from TS~~ feat(cli): generate yargs configuration from TS Nov 5, 2024

mrgrain changed the title ~~feat(cli): generate yargs configuration from TS~~ refactor(cli): generate yargs configuration from TS Nov 5, 2024

Merge branch 'main' into comcalvi/cli-yargs-code-gen

616e1fd

mrgrain had a problem deploying to test-pipeline November 5, 2024 10:47 — with GitHub Actions Failure

fix formatting

bf013e7

mrgrain had a problem deploying to test-pipeline November 5, 2024 11:35 — with GitHub Actions Failure

Merge branch 'main' into comcalvi/cli-yargs-code-gen

ddd7eae

mrgrain had a problem deploying to test-pipeline November 5, 2024 11:38 — with GitHub Actions Failure

latest updates

f7a09b0

mrgrain marked this pull request as ready for review November 5, 2024 11:50

mrgrain added pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested and removed pr/needs-cli-test-run This PR needs CLI tests run against it. labels Nov 5, 2024

mrgrain had a problem deploying to test-pipeline November 5, 2024 11:51 — with GitHub Actions Failure

mrgrain approved these changes Nov 5, 2024

View reviewed changes

mergify bot merged commit 4f8ecae into main Nov 5, 2024

mergify bot deleted the comcalvi/cli-yargs-code-gen branch November 5, 2024 12:20

github-actions bot locked as resolved and limited conversation to collaborators Nov 5, 2024

mrgrain added pr/do-not-merge This PR should not be merged at this time. and removed pr/do-not-merge This PR should not be merged at this time. labels Nov 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(cli): generate yargs configuration from TS#31850

refactor(cli): generate yargs configuration from TS#31850
mergify[bot] merged 29 commits intomainfrom
comcalvi/cli-yargs-code-gen

comcalvi commented Oct 22, 2024 •

edited

Loading

Uh oh!

aws-cdk-automation left a comment

Uh oh!

mrgrain commented Oct 23, 2024

Uh oh!

comcalvi commented Oct 23, 2024

Uh oh!

Uh oh!

aws-cdk-automation commented Nov 4, 2024

Uh oh!

aws-cdk-automation commented Nov 5, 2024

Uh oh!

mergify bot commented Nov 5, 2024

Uh oh!

github-actions bot commented Nov 5, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

comcalvi commented Oct 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue # (if applicable)

Reason for this change

Description of changes

Description of how you validated changes

Checklist

Uh oh!

aws-cdk-automation left a comment

Choose a reason for hiding this comment

Uh oh!

mrgrain commented Oct 23, 2024

Uh oh!

comcalvi commented Oct 23, 2024

Uh oh!

Uh oh!

aws-cdk-automation commented Nov 4, 2024

Uh oh!

aws-cdk-automation commented Nov 5, 2024

AWS CodeBuild CI Report

Uh oh!

mergify bot commented Nov 5, 2024

Uh oh!

github-actions bot commented Nov 5, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

comcalvi commented Oct 22, 2024 •

edited

Loading