pipelines: additionalInputs documentation is lacking in detail #30188
Labels
@aws-cdk/pipelines
CDK Pipelines library
documentation
This is a problem with documentation.
effort/medium
Medium work item – several days of effort
p2
Describe the issue
We have one repository with tooling and another repository with application code to be analyzed. This seems to fit with using toolingRepo as the main input and appRepo as an additionalInput. However, the documentation does not have enough detail to set this up correctly without trial and failure.
At first attempt I got the error message
Google led me to #17224 which is unhelpful, because the error message was actually true: The sibling directory
app-repo
did indeed exist.It turns out CodePipeline action provider "GitHub (Version 2)" and CodePipeline action input artifacts works together to put the repository source code in a sibling directory named the same as the repository. So the documentation may mention something like:
Once I had understood the above, my next task failed because a file was not found. It appears that when there are multiple source repositories, any step that does not explicitly set its
input
will just get one of them, including ones used inadditionalInputs
. So the documentation might make it clear:Links
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.pipelines-readme.html#additional-inputs
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.pipelines.ShellStepProps.html#additionalinputs
The text was updated successfully, but these errors were encountered: