[BREAKING] Usability improvements for the CodeBuild Construct library #412
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eladb
approved these changes
Jul 26, 2018
|
|
||
| const pipeline = new codepipeline.Pipeline(this, 'MyPipeline'); | ||
| const buildStage = new codepipeline.Stage(pipeline, 'Build'); | ||
| new codebuildPipeline.PipelineBuildAction(buildStage, 'CodeBuild', { | ||
| project: project, | ||
| project: project |
| @@ -10,12 +10,26 @@ import codebuildPipeline = require('@aws-cdk/aws-codebuild-codepipeline'); | |||
| import codepipeline = require('@aws-cdk/aws-codepipeline'); | |||
|
|
|||
| // see the @aws-cdk/aws-codebuild module for more documentation on how to create CodeBuild Projects | |||
| const project = new codebuild.BuildProject( // ... | |||
| ); | |||
| const project = new codebuild.Project(this, 'MyProject', { | |||
There was a problem hiding this comment.
Do you think there's value in walking through the layers here? Why would anyone work with this library if they don't want to use PipelineProject?
There was a problem hiding this comment.
Perhaps you can switch the order of the narrative? Start with PipelineProject and then explain that under the hood it is just a sugar for Project
There was a problem hiding this comment.
The main draw to this module is the PipelineBuildAction (and soon the PipelineTestAction), PipelineProject is just a small convenience :). But sure, I've switched around the narrative to start with PipelineProject.
1. Rename 'BuildProject' to 'Project'. 2. Allow setting the physical name of a Project, to make it consistent with other L2s. 3. Introduce a BuildImage class that makes it more convenient to specify the used Docker image. 4. Introduce a convenience PipelineProject class for use in CodePipeline that defaults the source and artifacts fields.
Thanks :) |
|
I would appreciate a merge if this looks good :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Continued from #3
By submitting this pull request, I confirm that my contribution is made under
the terms of the beta license.