Please watch/star this repo to help grow and support the project.
Cody is an AWS CodeBuild Management Tool. Cody lets you create AWS CodeBuild projects with a beautiful DSL. The documentation site is at: cody.run
cody init cody deploy cody start cody logs
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 .cody files.
- deploy: deploy the CodeBuild project on AWS.
- start: kick off a CodeBuild project run.
Init and Structure
cody init to generate a starter
.cody folder structure.
$ tree .cody .cody ├── buildspec.yml ├── project.rb └── role.rb
|buildspec.yml||The build commands to run. Here are the buildspec.yml syntax docs.|
|project.rb||The codebuild project written as a DSL. Here are the Project DSL docs|
|role.rb||The IAM role associated with the codebuild project written as a DSL. Here are the IAM Role DSL docs|
Adjust the files in
.cody to fit your needs. When you're ready, deploy the CodeBuild project with:
cody deploy PROJECT_NAME
cody deploy # infers the CodeBuild project name from the parent folder cody deploy PROJECT_NAME # explicitly specify project name
It is useful to just see the generated CloudFormation template with
cody deploy --noop # see generated CloudFormation template
For more help:
cody deploy -h
When you are ready to start a codebuild project run, you can use codebuild start. Examples:
cody start # infers the name from the parent folder cody start PROJECT_NAME # looks up project via CodeBuild project name
cody start command understands multiple identifiers. It will look up the codebuild project either via CloudFormation or the CodeBuild project name.
The start command continuously polls the CodeBuild project and prints out the logs until the build completes. To disable this, use the
cody start PROJECT_NAME --no-wait
The logs from the Phase Details and CloudWatch Logs are both displayed. Because they come from 2 different sources, the logs can interlace.
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 cody sets github_url("https://github.com/tongueroo/demo-ufo") linux_image("aws/codebuild/amazonlinux2-x86_64-standard:2.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
Cody 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, cody looks up files in the
.cody 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 cody
- 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