cdklabs / cdklabs/cdk-pipelines-github
docs: `yarn build` -> `yarn synth`
Open
- Dominant language
- TypeScript
- Stars
- 384
- Forks
- 45
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 4
Description
I was confused in the docs by this:
```ts
const pipeline = new GitHubWorkflow(app, 'Pipeline', {
synth: new ShellStep('Build', {
commands: [
'yarn install',
'yarn build',
],
}),
awsCreds: AwsCredentials.fromOpenIdConnect({
gitHubActionRoleArn: 'arn:aws:iam:::role/GitHubActionRole',
}),
});
```
because I didn't see where the synth command was being run. I think it would be more clear if you changed `yarn build` to `yarn synth` like the [CDK Pipeline docs](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.pipelines-readme.html) have.
Contributor guide
Assessment
This issue has not been assessed yet.