docs(core): update old recommendations in core README #28535
Conversation
`splitArn` is the correct updated version of `parseArn`. It's now necessary to use `ArnFormat` not a literal string for the format of the ARN resource for `splitArn` and `formatArn`. Finally, to fit with the recommendations to use a singleton pattern for custom resource handlers, the docs for Lambda are changed to recommend just using a `SingletonFunction`.
github-actions
bot
added
the
star-contributor
There was a problem hiding this comment.
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.
laurelmay
changed the title
aws-cdk-automation
dismissed
their stale review
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
|
@Mergifyio update |
✅ Branch has been successfully updated |
|
Okay so it looks like I need to make some small changes to the fixtures. But also it seems like I'll probably also work on a separate PR to add a |
|
I am also curious whether they both actually need to exist? It does seem like |
|
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). |
aws-cdk-automation
added
the
pr/needs-community-review
There was a problem hiding this comment.
Hmm you're right. My best guess is that we want to keep this behavior so that both show up in the generated docs. So I'm happy with this update and also something in the future to ensure they stay in sync.
It shouldn't be in prlint though. I think it can just be a special case of awslint where we check that these two files match.
There was a problem hiding this comment.
Hmm you're right. My best guess is that we want to keep this behavior so that both show up in the generated docs. So I'm happy with this update and also something in the future to ensure they stay in sync.
It shouldn't be in prlint though. I think it can just be a special case of awslint where we check that these two files match.
aws-cdk-automation
removed
the
pr/needs-community-review
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
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). |
`splitArn` is the correct updated version of `parseArn`. It's now necessary to use `ArnFormat` not a literal string for the format of the ARN resource for `splitArn` and `formatArn`. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
splitArnis the correct updated version ofparseArn. It's nownecessary to use
ArnFormatnot a literal string for the format of theARN resource for
splitArnandformatArn.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license