chore(core): Add warnings about using core functions from outside of Solutions Constructs #917
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
biffgaut
requested review from
hayesry,
mobri2a,
emcfins,
mickychetta and
georgebearden
as code owners
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
georgebearden
pushed a commit
that referenced
this pull request
Mar 23, 2023
…Solutions Constructs (#917) * Add file header warning * Add function header comments * Use latest CDK to address .NET version issue * Fix 2 typos * One last typo
biffgaut
added a commit
that referenced
this pull request
Jul 26, 2023
* README for new openapi-based apigatway-to-lambda construct. * fix(core) prevent lambda id conflict with multiple buildLambdaFunction() calls in the same stack (#910) * chore(release): 2.33.0 * chore(release prep): Update CHANGELOG.md and align-version.js * Freeze @types/node version in cdk-integ * Freeze @types/node version in cdk-integ * Update step functions integ tests * chore(core): Add warnings about using core functions from outside of Solutions Constructs (#917) * Add file header warning * Add function header comments * Use latest CDK to address .NET version issue * Fix 2 typos * One last typo * fix(StepFunctions): Address LogGroup behavior problems (#922) * Implementation * Clean up some code cruft * Update package.json * chore(release): 2.34.0 * chore(release-prep): Updated CHANGELOG.md and align-version.js * chore(release-prep): align-version.js * chore(core): migrate to assertions (#929) * First two test updates * chore(core): migrate to assertions * Remove old lib, final few modules * Update the cloudfront-to-s3 construct to correctly set the logging bucket property. (#930) * Update README * Update openapigateway-to-lambda README * Update README/architecture for openapigateway-to-lambda. * Add openapigateway-to-lambda code and initial tests * update openapigateway-to-lambda package.json dependency versions. * Update openapigateway-to-lambda * Update openapigateway README * don't depend on NodeJsFunction docker env * Update openapigateway-to-lambda README to reflect actual construct API. * temp commit * Update snapshot test for openapigateway-to-lambda construct. * fix package.json version field * update snapshot * update openapigateway-to-lambda custom resource to suppress standard cfn nag warnings. * [wip] resources project * fix dependency self reference on new resources module * fix dependency self reference on new resources module * Add integ test to the template writer resource. * Add integ tests to template-writer resource. * Update template-writer resource integ tests to clean up test buckets automatically * Add additinal tests to get 100% coverage on aws-openapigateway-lambda * Add additional integration tests to template resource writer and aws-openapigateway-lambda. * remove eslintignore line that was obsolete * cleanup eslint ignore and update openapigateway-to-lambda props. * Update python/java code samples for openapigateway-to-lambda. * Update openapigateway-to-lambda README * Update resources README * Update resources integ test * update resources integ test snapshot * Update integ test snapshots for aws-openapigateway-lambda. * Update aws-openapigateway-lambda construct to trigger api deployments anytime the incoming api template changes or any time the lambda functions change. * Add new integ test for cognito authorizer on aws-openapigateway-lambda construct. * address minor pr feedback. * Remove integration tests that use BucketDeployment as the asset hash of the AwsCliLayer changes outside our control. * Remove integration tests that use BucketDeployment as the asset hash of the AwsCliLayer changes outside our control. * Address pr feedback. Add new template writer integration test for transforming large template with several thousand substitutions Several new comments/documentation to make the obscure less so, hopefully> * Add additional tests to aws-openapigateway-lambda construct. * Update integ tests after latest cdk lib update. * Add optional construct id parameter to the buildLambdaFunction function. * Update aws-openapigateway-lambda property descriptions to better explain optional custom resource values. --------- Co-authored-by: Andriy <andriy.frankevych@gmail.com> Co-authored-by: AWS Solutions Constructs Automation <aws-solutions-constructs-team@amazon.com> Co-authored-by: biffgaut <biffgaut@amazon.com> Co-authored-by: biffgaut <78155736+biffgaut@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
Description of changes:
Internal core functions are not documented and can change outside the scope of a major release, so should not be used from outside without understanding the risk that they can change. This PR adds comments and JSDoc notices to that effect.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.