Skip to content

Commit

Permalink
docs(codepipeline): add note about repoString param resolvability at …
Browse files Browse the repository at this point in the history
…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*
  • Loading branch information
Nikola-Milovic committed Sep 13, 2023
1 parent 07c6775 commit 864e76a
Showing 1 changed file with 1 addition and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
Expand Down

0 comments on commit 864e76a

Please sign in to comment.