From 864e76a8514c872221fa332a4f3e99e144f4330a Mon Sep 17 00:00:00 2001 From: Nikola Milovic <50072027+Nikola-Milovic@users.noreply.github.com> Date: Wed, 13 Sep 2023 16:07:59 +0200 Subject: [PATCH] docs(codepipeline): add note about repoString param resolvability at 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* --- .../pipelines/lib/codepipeline/codepipeline-source.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/aws-cdk-lib/pipelines/lib/codepipeline/codepipeline-source.ts b/packages/aws-cdk-lib/pipelines/lib/codepipeline/codepipeline-source.ts index 659cb3d4d514f..85e9c3702645c 100644 --- a/packages/aws-cdk-lib/pipelines/lib/codepipeline/codepipeline-source.ts +++ b/packages/aws-cdk-lib/pipelines/lib/codepipeline/codepipeline-source.ts @@ -101,7 +101,7 @@ export abstract class CodePipelineSource extends Step implements ICodePipelineAc * If you need access to symlinks or the repository history, be sure to set * `codeBuildCloneOutput`. * - * @param repoString A string that encodes owner and repository separated by a slash (e.g. 'owner/repo'). + * @param repoString A string that encodes owner and repository separated by a slash (e.g. 'owner/repo'). The provided string must be resolvable at runtime. * @param branch The branch to use. * @param props The source properties, including the connection ARN. *