docs(codepipeline): add note about repoString param resolvability at runtime #27109
Conversation
github-actions
bot
added
beginning-contributor
aws-cdk-automation
added
the
pr/needs-community-review
| @@ -102,6 +102,7 @@ export abstract class CodePipelineSource extends Step implements ICodePipelineAc | |||
| * `codeBuildCloneOutput`. | |||
| * | |||
| * @param repoString A string that encodes owner and repository separated by a slash (e.g. 'owner/repo'). | |||
| * Note: The provided string must be resolvable at runtime. Unresolved tokens will lead to runtime errors. | |||
There was a problem hiding this comment.
@Nikola-Milovic I don't like adding this between @params. We do some weird parsing in jsii and this could ruin the [brittle] parser. Let's keep it on the same line, or show me a screenshot of what the rendered docstring looks like to prove to me that it's rendered properly.
There was a problem hiding this comment.
Yeah, I agree that it could cause a problem. In VSCode and Neovim it looks fine, but even in those two, there is a discrepancy as to how the output from the LSP is shown. VSCode puts it all in the same line, while Neovim retains the new line.
What do you think of the new version? Removed the extra fluff sentence and made it continuous.
A side question, how do you avoid having really long lines for these @params if a newline can mess up the jsii parser?
There was a problem hiding this comment.
I'm not sure if it does mess it up. If it looks fine in VSCode when you hover over the prop then I think its fine. I was asking for a screenshot of that if you wanted to keep them on separate lines, since I am lazy and do not want to check out your branch just to check :)
|
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
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). |
…runtime (#27109) This PR addresses an issue encountered when setting up an AWS CDK pipeline where unresolved token values for the `repoString` parameter led to a runtime error. The updated docstring now explicitly mentions that the `repoString` must be resolvable at runtime and that unresolved tokens are intended to be a runtime error Closes #27100. Thanks to @peterwoodworth for the quick assessment and the proposed solution to the problem. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
This PR addresses an issue encountered when setting up an AWS CDK pipeline where unresolved token values for the
repoStringparameter led to a runtime error. The updated docstring now explicitly mentions that therepoStringmust be resolvable at runtime and that unresolved tokens are intended to be a runtime errorCloses #27100.
Thanks to @peterwoodworth for the quick assessment and the proposed solution to the problem.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license