The codebuild tool provides a DSL to create a CodeBuild project with some reasonable defaults.
The codebuild tool installs
codebuild executables. Both of them do the same thing,
cb is just shorter to type.
The documentation site is at: codebuild.cloud
cb init cb deploy cb start
IMPORTANT: Before deploying, if you are using a private repo, use aws codebuild import-source-credentials to add credentials so that codebuild can clone down the repo. Refer to the CodeBuilld Github Oauth/ for more info.
- init: generate starter .codebuild files.
- deploy: deploy the CodeBuild project on AWS.
- start: kick off a CodeBuild project run.
Init and Structure
codebuild init to generate a starter .codebuild structure.
$ tree .codebuild .codebuild ├── buildspec.yml ├── project.rb └── role.rb
|buildspec.yml||The build commands to run.|
|project.rb||The codebuild project written as a DSL.|
|role.rb||The IAM role associated with the codebuild project written as a DSL.|
Adjust the files in
.codebuild to fit your needs. When you're ready, deploy the CodeBuild project with:
cb deploy STACK_NAME
cb deploy # infers the CloudFormation name from the parent folder cb deploy stack-name # explicitly specify stack name
It is useful to just see the generated CloudFormation template with
cb deploy --noop # see generated CloudFormation template
For more help:
cb deploy -h
When you are ready to start a codebuild project run, you can use
codebuild start. Examples:
cb start # infers the name from the parent folder cb start stack-name # looks up project via CloudFormation stack cb start demo-project # looks up project via CodeBuild project name
cb start command understands multiple identifiers. It will look up the codebuild project either via CloudFormation or the CodeBuild project name.
The tool provides a DSL to create a codebuild project. Here's an example.
# name("demo") # recommended to leave unset and use the conventional name that cb tool sets github_url("https://github.com/tongueroo/demo-ufo") linux_image("aws/codebuild/ruby:2.5.3-1.7.0") environment_variables( UFO_ENV: "development", API_KEY: "ssm:/codebuild/demo/api_key" # ssm param example )
Here's a list of some of the convenience shorthand DSL methods:
Please refer to lib/codebuild/dsl/project.rb for the full list.
More slightly more control, you may be interested in the
linux_environment methods. For even more control, see DSL docs.
IAM Role DSL
The codebuild tool can create the IAM service role associated with the codebuild project. Here's an example:
For more control, here's a longer form:
iam_policy( action: [ "logs:CreateLogGroup", "logs:CreateLogStream", "logs:PutLogEvents", "ssm:*", ], effect: "Allow", resource: "*" )
You can also create managed iam policy.
rate "1 day"
The convenience DSL methods shown above are short and clean. They merely wrap a DSL that map to the properties of CloudFormation resources like AWS::CodeBuild::Project and AWS::IAM::Role. Refer the DSL docs for more info.
By default, the codebuild tool looks up files in the
.codebuild folder. You can affect the behavior of the Type logic with the
--Type option. More info Type docs.
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
gem install codebuild
- Fork it
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am "Add some feature")
- Push to the branch (
git push origin my-new-feature)
- Create new Pull Request