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.

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

chore(v2): literate examples missing from v2 #18118

Merged
merged 7 commits into from
Dec 28, 2021
Merged

chore(v2): literate examples missing from v2 #18118

merged 7 commits into from
Dec 28, 2021

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented Dec 21, 2021

The literate examples are test/*.lit.ts files that are included
in the READMEs by jsii.

Ubergen didn't copy test files, because there were issues with the
test dependency @aws-cdk/assert which couldn't be included into
aws-cdk-lib.

In this PR, add copying of only the literate source files to ubergen
so that we can include the examples again in READMEs. It is safe since
those are integration tests that don't depend on @aws-cdk/assert
(which is only used by unit tests).

Updated some EKS integ tests to no longer depend on test files that
don't get copied by this mechanism (./util.ts).


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

The literate examples are `test/*.lit.ts` files that are included
in the `README`s by jsii.

Ubergen didn't copy `test` files, because there were issues with the
test dependency `@aws-cdk/assert` which couldn't be included into
`aws-cdk-lib`.

In this PR, add copying of only the literate source files to `ubergen`
so that we can include the examples again in READMEs. It is safe since
those are integration tests that don't depend on `@aws-cdk/assert`
(which is only used by unit tests).
@rix0rrr rix0rrr requested a review from a team December 21, 2021 17:27
@rix0rrr rix0rrr self-assigned this Dec 21, 2021
@gitpod-io
Copy link

gitpod-io bot commented Dec 21, 2021

@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Dec 21, 2021
@github-actions github-actions bot added the aws-cdk-lib Related to the aws-cdk-lib package label Dec 21, 2021
@@ -554,7 +572,6 @@ const IGNORED_FILE_NAMES = new Set([
'.npmignore',
'node_modules',
'package.json',
'test',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this really be removed? Looks like it should stay, based on a quick skim of where it's used.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep

@rix0rrr rix0rrr requested review from njlynch and a team December 23, 2021 10:30
@mergify
Copy link
Contributor

mergify bot commented Dec 28, 2021

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

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
  • Commit ID: 300027e
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@mergify mergify bot merged commit e2c8063 into master Dec 28, 2021
@mergify mergify bot deleted the huijbers/v2-lits branch December 28, 2021 13:26
@mergify
Copy link
Contributor

mergify bot commented Dec 28, 2021

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

TikiTDO pushed a commit to TikiTDO/aws-cdk that referenced this pull request Feb 21, 2022
The literate examples are `test/*.lit.ts` files that are included
in the `README`s by jsii.

Ubergen didn't copy `test` files, because there were issues with the
test dependency `@aws-cdk/assert` which couldn't be included into
`aws-cdk-lib`.

In this PR, add copying of only the literate source files to `ubergen`
so that we can include the examples again in READMEs. It is safe since
those are integration tests that don't depend on `@aws-cdk/assert`
(which is only used by unit tests).

Updated some EKS integ tests to no longer depend on test files that
don't get copied by this mechanism (`./util.ts`).


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
aws-cdk-lib Related to the aws-cdk-lib package contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants