chore: rewrite readmes correctly in aws-cdk-lib and monocdk #17573

kaizencc · 2021-11-18T21:32:15Z

Adds rewriteImports and helper functions rewriteReadmeImports and rewriteMonoPackageImports to aws-cdk-migration package.
individual-package-gen consumes rewriteReadmeImports for alpha modules.
individual-package-gen treats rosetta fixtures as source files and rewrites imports there as well.
Adds aws-cdk-migration as a dependency to ubergen.
Refactors rewriteImports in ubergen to use the API in aws-cdk-migration. Has the side affect of removing the string-replace function that was introduced in this PR. This changes the readme import style from import { blah as blah } from 'aws-cdk-lib'; to import * as blah from 'aws-cdk-lib/blah';.
fixes error in cfnspec that generated invalid import names for L1 module readmes.
fixes bug in cdk-build that only executed one post command.
fixes verify-imports scripts typo introduced previously (that was not caught due to the cdk-build bug).

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

gitpod-io · 2021-11-18T21:32:18Z

kaizencc · 2021-11-18T21:35:29Z

There is a lot going on in this PR and some of it likely does not belong in the same PR together. Especially because the origin of this PR is v2-main and not master. That is why it is marked as draft; hoping we can talk about what makes sense and what doesn't here and then decide on what/how to merge.

tools/@aws-cdk/ubergen/bin/ubergen.ts

kaizencc · 2021-11-19T21:55:08Z

Couple of things @rix0rrr:

build breaks because the verify-readme-imports script in aws-cdk-lib is very unhappy as the readme import styles have changed. We can either remove that check, return the original string-replace stuff into ubergen, or refactor code in aws-cdk-lib to produce the imports we want to see in readmes (i looked at this option and it seems doable, but non-trivial).
i am sure you have plenty more opinions on this PR so I have not yet rebased to master.
i reverted all code in @monocdk-experimental/rewrite-imports (since its no longer used by ubergen. I am not even sure if that is currently used anywhere in the CDK. might be possible to delete?

rix0rrr · 2021-11-22T13:56:09Z

packages/@aws-cdk/cfnspec/lib/library-creation.ts

    '',
    '```ts',
-    `import ${module.moduleName.toLocaleLowerCase()} = require('${module.packageName}');`,
+    `import * as ${module.moduleName.toLocaleLowerCase().replace(/-/g, '_')} from '${module.packageName}';`,


Should this not be the same old, same old "guess import name from module name" function that we have in a bunch of places? Might also be centralized here...

I guess this will do, but it's perhaps worth considering

I think it might be overkill to add it here, since this is just a suggested name and can really be anything at this point. No need to add the module function from generated-examples, which is what I think you're referring to. Instead, I have added a more robust regex to ensure that the module name is always valid.

packages/aws-cdk-migration/lib/rewrite.ts

kaizencc · 2021-11-22T20:48:34Z

@Mergifyio backport master

mergify · 2021-11-22T20:49:09Z

backport master

🟠 Waiting for conditions to match

merged [:pushpin: backport requirement]

aws-cdk-automation · 2021-11-22T21:20:39Z

AWS CodeBuild CI Report

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

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

mergify · 2021-11-22T21:23:02Z

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

- Adds `rewriteImports` and helper functions `rewriteReadmeImports` and `rewriteMonoPackageImports` to `aws-cdk-migration` package. - `individual-package-gen` consumes `rewriteReadmeImports` for alpha modules. - `individual-package-gen` treats rosetta fixtures as source files and rewrites imports there as well. - Adds `aws-cdk-migration` as a dependency to `ubergen`. - Refactors `rewriteImports` in `ubergen` to use the API in `aws-cdk-migration`. Has the side affect of removing the string-replace function that was introduced in this [PR](#14255). This changes the readme import style from `import { blah as blah } from 'aws-cdk-lib';` to `import * as blah from 'aws-cdk-lib/blah';`. - fixes error in `cfnspec` that generated invalid import names for L1 module readmes. - fixes bug in `cdk-build` that only executed one `post` command. - fixes `verify-imports` scripts typo introduced previously (that was not caught due to the `cdk-build` bug). ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license* (cherry picked from commit 66e37cc) # Conflicts: # packages/@aws-cdk/cfnspec/lib/library-creation.ts

mergify · 2021-11-22T21:23:23Z

backport master

✅ Backports have been created

#17635 chore: rewrite readmes correctly in aws-cdk-lib and monocdk (backport #17573) has been created for branch master

…17573) (#17635) This is an automatic backport of pull request #17573 done by [Mergify](https://mergify.com). Cherry-pick of 66e37cc has failed: ``` On branch mergify/bp/master/pr-17573 Your branch is up to date with 'origin/master'. You are currently cherry-picking commit 66e37cc. (fix conflicts and run "git cherry-pick --continue") (use "git cherry-pick --skip" to skip this patch) (use "git cherry-pick --abort" to cancel the cherry-pick operation) Changes to be committed: modified: packages/@aws-cdk/cfnspec/test/libary-creation.test.ts modified: packages/aws-cdk-lib/.gitignore modified: packages/aws-cdk-lib/package.json modified: packages/aws-cdk-lib/scripts/verify-imports-resolve-same.ts deleted: packages/aws-cdk-lib/scripts/verify-readme-import-rewrites.ts modified: packages/aws-cdk-migration/bin/rewrite-imports-v2.ts modified: packages/aws-cdk-migration/lib/rewrite.ts modified: packages/aws-cdk-migration/test/rewrite.test.ts modified: packages/monocdk/.gitignore modified: tools/@aws-cdk/cdk-build-tools/bin/cdk-build.ts modified: tools/@aws-cdk/individual-pkg-gen/transform-packages.ts modified: tools/@aws-cdk/ubergen/bin/ubergen.ts modified: tools/@aws-cdk/ubergen/package.json Unmerged paths: (use "git add <file>..." to mark resolution) both modified: packages/@aws-cdk/cfnspec/lib/library-creation.ts ``` To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally --- <details> <summary>Mergify commands and options</summary> <br /> More conditions and actions can be found in the [documentation](https://docs.mergify.com/). You can also trigger Mergify actions by commenting on this pull request: - `@Mergifyio refresh` will re-evaluate the rules - `@Mergifyio rebase` will rebase this PR on its base branch - `@Mergifyio update` will merge the base branch into this PR - `@Mergifyio backport <destination>` will backport this PR on `<destination>` branch Additionally, on Mergify [dashboard](https://dashboard.mergify.com/) you can: - look at your merge queues - generate the Mergify configuration with the config editor. Finally, you can contact us on https://mergify.com </details>

…ws#17573) (aws#17635) This is an automatic backport of pull request aws#17573 done by [Mergify](https://mergify.com). Cherry-pick of 66e37cc has failed: ``` On branch mergify/bp/master/pr-17573 Your branch is up to date with 'origin/master'. You are currently cherry-picking commit 66e37cc. (fix conflicts and run "git cherry-pick --continue") (use "git cherry-pick --skip" to skip this patch) (use "git cherry-pick --abort" to cancel the cherry-pick operation) Changes to be committed: modified: packages/@aws-cdk/cfnspec/test/libary-creation.test.ts modified: packages/aws-cdk-lib/.gitignore modified: packages/aws-cdk-lib/package.json modified: packages/aws-cdk-lib/scripts/verify-imports-resolve-same.ts deleted: packages/aws-cdk-lib/scripts/verify-readme-import-rewrites.ts modified: packages/aws-cdk-migration/bin/rewrite-imports-v2.ts modified: packages/aws-cdk-migration/lib/rewrite.ts modified: packages/aws-cdk-migration/test/rewrite.test.ts modified: packages/monocdk/.gitignore modified: tools/@aws-cdk/cdk-build-tools/bin/cdk-build.ts modified: tools/@aws-cdk/individual-pkg-gen/transform-packages.ts modified: tools/@aws-cdk/ubergen/bin/ubergen.ts modified: tools/@aws-cdk/ubergen/package.json Unmerged paths: (use "git add <file>..." to mark resolution) both modified: packages/@aws-cdk/cfnspec/lib/library-creation.ts ``` To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally --- <details> <summary>Mergify commands and options</summary> <br /> More conditions and actions can be found in the [documentation](https://docs.mergify.com/). You can also trigger Mergify actions by commenting on this pull request: - `@Mergifyio refresh` will re-evaluate the rules - `@Mergifyio rebase` will rebase this PR on its base branch - `@Mergifyio update` will merge the base branch into this PR - `@Mergifyio backport <destination>` will backport this PR on `<destination>` branch Additionally, on Mergify [dashboard](https://dashboard.mergify.com/) you can: - look at your merge queues - generate the Mergify configuration with the config editor. Finally, you can contact us on https://mergify.com </details>

kaizencc added 5 commits November 18, 2021 15:45

add rewriteReadmeImports

1a495c8

treat rosetta fixtures as source files and rewrite readme imports

3c65913

add rewriteReadmeImports to @monocdk/experiment

81f0176

add new line to end of file

2b836bb

refactor rewritereadmeimports

8293129

kaizencc requested a review from rix0rrr November 18, 2021 21:32

kaizencc marked this pull request as draft November 18, 2021 21:32

github-actions bot assigned nija-at Nov 18, 2021

github-actions bot added the aws-cdk-lib Related to the aws-cdk-lib package label Nov 18, 2021

kaizencc unassigned nija-at Nov 18, 2021

mergify bot added the contribution/core This is a PR that came from AWS. label Nov 18, 2021

rix0rrr reviewed Nov 19, 2021

View reviewed changes

tools/@aws-cdk/ubergen/bin/ubergen.ts Outdated Show resolved Hide resolved

kaizencc added 5 commits November 19, 2021 12:39

refactor rewriteReadmeImports

33470ba

remove @monocdk-experiment from this PR

0312683

refactor rewriteImports

29568c3

ubergen stuff

a62dc13

chore(cfnspec): missing L1 module readmes have valid import statements

8b53c5a

github-actions bot assigned nija-at Nov 19, 2021

rix0rrr reviewed Nov 22, 2021

View reviewed changes

kaizencc and others added 4 commits November 22, 2021 09:21

add stronger regex

0a65dca

rename updatedLocationof

7330033

remove verify-readme-import-rewrites from build steps

b700fbd

Merge branch 'v2-main' into kaizen-v2-main

1398e04

rix0rrr approved these changes Nov 22, 2021

View reviewed changes

kaizencc added 2 commits November 22, 2021 11:19

fix filename

5f2ab33

fix verify-imports script and gitignore

f25b072

kaizencc added the pr/do-not-merge This PR should not be merged at this time. label Nov 22, 2021

kaizencc added 3 commits November 22, 2021 12:31

fix cdk-build to accept multiple post commands

cee4f49

gitignore typo

d941671

fix horrific bug that breaks assert build

f10452a

kaizencc marked this pull request as ready for review November 22, 2021 20:50

kaizencc removed the pr/do-not-merge This PR should not be merged at this time. label Nov 22, 2021

mergify bot merged commit 66e37cc into v2-main Nov 22, 2021

mergify bot deleted the kaizen-v2-main branch November 22, 2021 21:22

mergify bot mentioned this pull request Nov 22, 2021

chore: rewrite readmes correctly in aws-cdk-lib and monocdk (backport #17573) #17635

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore: rewrite readmes correctly in aws-cdk-lib and monocdk #17573

chore: rewrite readmes correctly in aws-cdk-lib and monocdk #17573

Uh oh!

kaizencc commented Nov 18, 2021 •

edited

Loading

Uh oh!

gitpod-io bot commented Nov 18, 2021

Uh oh!

kaizencc commented Nov 18, 2021

Uh oh!

Uh oh!

kaizencc commented Nov 19, 2021

Uh oh!

rix0rrr Nov 22, 2021

Uh oh!

kaizencc Nov 22, 2021

Uh oh!

Uh oh!

kaizencc commented Nov 22, 2021

Uh oh!

mergify bot commented Nov 22, 2021

Uh oh!

aws-cdk-automation commented Nov 22, 2021

Uh oh!

mergify bot commented Nov 22, 2021

Uh oh!

mergify bot commented Nov 22, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

chore: rewrite readmes correctly in aws-cdk-lib and monocdk #17573

chore: rewrite readmes correctly in aws-cdk-lib and monocdk #17573

Uh oh!

Conversation

kaizencc commented Nov 18, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gitpod-io bot commented Nov 18, 2021

Uh oh!

kaizencc commented Nov 18, 2021

Uh oh!

Uh oh!

kaizencc commented Nov 19, 2021

Uh oh!

rix0rrr Nov 22, 2021

Choose a reason for hiding this comment

Uh oh!

kaizencc Nov 22, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kaizencc commented Nov 22, 2021

Uh oh!

mergify bot commented Nov 22, 2021

🟠 Waiting for conditions to match

Uh oh!

aws-cdk-automation commented Nov 22, 2021

AWS CodeBuild CI Report

Uh oh!

mergify bot commented Nov 22, 2021

Uh oh!

mergify bot commented Nov 22, 2021

✅ Backports have been created

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kaizencc commented Nov 18, 2021 •

edited

Loading