codebuild 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33951b000f2bf84f71be30e140a7a4695a682ad8968c436d42a5db5d7d67fa28
-  data.tar.gz: a733a751be68e8dad431a18497f2b9cd7519ff5de0713f64d63f5c5d59617080
+  metadata.gz: 95697bfe6c4ae37bb84258a9b2067494efcc83e259f9a03bd9e4a2088d579f52
+  data.tar.gz: b472131c142171e67aa7fa5f0d4e7f12e35efe18572408d3f002ead4cb230687
 SHA512:
-  metadata.gz: d7884e4ec583b5f79432d7e90ebc8f8f990cb65a9449582570ce4c1aa2b77be17790198c743536daa04de9fc553228f16f3577718d79308dd60f27bb2ca7615e
-  data.tar.gz: aed632aa572e849971a1d26db326796615499b25bf4748b5a9932ceef9f1f5ca86914062d5efa887f1dcd1a9f1bf96a32ab785e9c01fd21dc95488df53f9add4
+  metadata.gz: ee5f2784e0986fbd38ed79df15089ed8eb031a8da983dbb7c690fbf1084ab0a21b2e4327ec8d4ac99cf29aecb2431f217b3ca745a22c6797f986f0eaf39ac5e0
+  data.tar.gz: f4334660cfc0c108b03fecc451d1cbf7742ec5c223b4964bd8969006d8a9aaea6e7a9ddb54dfe8ce7fdaa1ab633d7ccbd2e39130e33b958f7b015ce59973430f

data/CHANGELOG.md

@@ -3,6 +3,11 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.6.0]
+- named stack with -cb at the very end
+- add docs
+- cb init --no-variables option
+
 ## [0.5.0]
 - add --wait option
 - change default append_env setting to false

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2018 Tung Nguyen
+Copyright (c) 2019 Tung Nguyen
 
 MIT License
 

data/README.md

@@ -1,6 +1,6 @@
 # Codebuild
 
-![Build Status](https://codebuild.us-west-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoidHFFaithL1pLZWFEUzBXbk5LY05Mc0FrZW56NDVJWTArbUlOdzBUalVPWWZ5a1ZYUEFtTkhlbFBjeURRZEd1Q292WTI1RUJwWkcvdEgxUXhSYnBqVU9VPSIsIml2UGFyYW1ldGVyU3BlYyI6IjJ0dnpqMC9XMzQ4VExCMGgiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)
+![Build Status](https://codebuild.us-west-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiSUFzNE9RV3ROWmNKOHh2NG1wTjNmRlV4dnlOTnVrK3U2UFMrOEJRUGE2WS9mcjRWS0o1bjdSZlN5bG1tR1YyYVFlNkErTGdkbThsWExUaVJvWU1PRUY4PSIsIml2UGFyYW1ldGVyU3BlYyI6InppWWxJRGFiWHN1bEtYSzIiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)
 
 The codebuild tool provides a DSL to create a CodeBuild project with some reasonable defaults.
 
@@ -22,7 +22,7 @@ IMPORTANT: Before deploying, if you are using a private repo, use [aws codebuild
 2. **deploy**: deploy the CodeBuild project on AWS.
 3. **start**: kick off a CodeBuild project run.
 
-### Init
+### Init and Structure
 
 First, run `codebuild init` to generate a starter .codebuild structure.
 
@@ -127,6 +127,14 @@ You can also create managed iam policy.
 managed_iam_policy("AmazonS3ReadOnlyAccess")
 ```
 
+## Schedule Support
+
+.codebuild/schedule.rb:
+
+```ruby
+rate "1 day"
+```
+
 ## Full DSL
 
 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) and [AWS::IAM::Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html). Refer the [DSL docs](docs/dsl) for more info.

data/docs/.gitignore

@@ -0,0 +1,4 @@
+_site
+.sass-cache
+.jekyll-metadata
+Gemfile.lock

data/docs/CNAME

@@ -0,0 +1 @@
+codebuild.cloud

data/docs/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "jekyll"

data/docs/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Tung Nguyen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/docs/README.md

@@ -0,0 +1,25 @@
+# Codebuild Documentation
+
+This project powers the codebuild documementation website: [https://codebuild.cloud](https://codebuild.cloud).  It is a static website generated by [Jekyll](https://jekyllrb.com/).
+
+## Contributing
+
+For minor changes like typos, you can click **Suggest an edit to this page**, located at the bottom of each article. This will take you to the source file on GitHub, where you can submit a pull request for your change through the UI.
+
+## Local Setup
+
+For larger fixes, you can run the site locally with the following:
+
+    git clone https://github.com/tongueroo/codebuild.git
+    cd codebuild/docs
+    bundle
+    bin/web
+
+You'll be able to view the site on [http://localhost:4000](http://localhost:4000).
+
+## Rordering Site Nav
+
+To reorder the `nav_order` for links on the sidenav run:
+
+    cd docs
+    jekyll-sort reorder

data/docs/_config.yml

@@ -0,0 +1,73 @@
+# Site settings
+title: codebuild
+email: tongueroo@gmail.com
+url: https://codebuild.cloud
+description: "The codebuild tool provides a DSL to create a CodeBuild project with some reasonable defaults."
+keywords: "codebuild boltops dsl ruby aws"
+skills: ""
+meta_author: Tung Nguyen
+
+# Google webmaster tools
+google_verify:
+google_analytics: UA-98684555-11
+
+# https://ssl.bing.com/webmaster/configure/verify/ownership Option 2 content= goes here
+bing_verify:
+
+# Contact form:
+# - static : pass through formspree.io to validate email sending
+# - disqus : replace contact form by disqus thread
+# - comment the line below if you want to stick with the default PHP contact form
+contact: static
+
+# If you use disqus you need disqus shortname
+# https://help.disqus.com/customer/portal/articles/466208
+disqus_shortname:
+
+# Color settings (hex-codes without the leading hash-tag)
+color:
+  primary: 3972c7
+  primary-rgb: "24,288,156" #"128,179,255"
+  secondary: 2c3e50 #FD6E8A
+  secondary-dark: 233140 #A2122F
+  links: a3c8ff
+
+# Footer settings
+footer:
+  copyright: BoltOps, LLC
+  location: San Francisco, CA
+  social: BoltOps
+  credits:
+  contact: contact@boltops.com
+  phone:
+
+# Social networks usernames (many more available: google-plus, flickr, dribbble, pinterest, instagram, tumblr, linkedin, etc.)
+social:
+  - title: twitter
+    url: http://twitter.com/tongueroo
+  - title: github
+    url: https://github.com/tongueroo/codebuild
+
+# Credits content
+credits:
+
+# Build settings
+markdown: kramdown
+permalink: pretty
+
+gh_url: https://github.com/tongueroo/codebuild
+
+collections:
+  docs:
+    name: "Documentation"
+    output: true
+  reference:
+    name: "Reference"
+    output: true
+
+defaults:
+  - values:
+      layout: default
+
+plugins_dir:
+ - jekyll-coffeescript

data/docs/_docs/contributing.md

@@ -0,0 +1,99 @@
+---
+title: Contributing
+---
+
+Hi there! Interested in contributing to CodeBuild? We'd love your help. CodeBuild is an open source project, built one contribution at a time by users like you.
+
+## Where to get help or report a problem
+
+See [the support guidelines]({% link support.md %})
+
+## Ways to contribute
+
+Whether you're a developer, an infrastructure engineer, or just an enthusiast, there are lots of ways to contribute. Here are a few ideas:
+
+* [Install CodeBuild on your computer](https://https://codebuild.cloud.com/docs/install/) and kick the tires. Does it work? Does it do what you'd expect? If not, [open an issue](https://github.com/tongueroo/codebuild/issues/new/choose) and let us know.
+* Comment on some of the project's [open issues](https://github.com/tongueroo/codebuild/issues). Have you experienced the same problem? Know a workaround? Do you have a suggestion for how the feature could be better?
+* Read through [the documentation](https://https://codebuild.cloud.com/docs/), and click the "improve this page" button, any time you see something confusing or have a suggestion for something that could be improved.
+* Browse through the [CodeBuild Community forum](https://community.https://codebuild.cloud.com), and lend a hand answering questions. There's a good chance you've already experienced what another user is experiencing.
+* Find [an open issue](https://github.com/tongueroo/codebuild/issues) (especially [those labeled `help wanted`](https://github.com/tongueroo/codebuild/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)), and submit a proposed fix. If it's your first pull request, we promise we won't bite and are glad to answer any questions.
+* Help evaluate [open pull requests](https://github.com/tongueroo/codebuild/pulls), by testing the changes locally and reviewing what's proposed.
+
+## Submitting a pull request
+
+### Pull requests generally
+
+* The smaller the proposed change, the better. If you'd like to propose two unrelated changes, submit two pull requests.
+
+* The more information, the better. Make judicious use of the pull request body. Describe what changes were made, why you made them, and what impact they will have for users.
+
+* If this is your first pull request, it may help to [understand GitHub Flow](https://guides.github.com/introduction/flow/).
+
+* If you're submitting a code contribution, be sure to read the [code contributions](#code-contributions) section below.
+
+### Submitting a pull request via github.com
+
+Many small changes can be made entirely through the github.com web interface.
+
+1. Navigate to the file within [tongueroo/codebuild](https://github.com/tongueroo/codebuild) that you'd like to edit.
+2. Click the pencil icon in the top right corner to edit the file.
+3. Make your proposed changes.
+4. Click "Propose file change."
+5. Click "Create pull request."
+6. Add a descriptive title and detailed description for your proposed change. The more information, the better.
+7. Click "Create pull request."
+
+That's it! You'll be automatically subscribed to receive updates as others review your proposed change and provide feedback.
+
+### Submitting a pull request via Git command line
+
+1. Fork the project by clicking "Fork" in the top right corner of [tongueroo/codebuild](https://github.com/tongueroo/codebuild).
+2. Clone the repository locally `git clone https://github.com/<your-username>/codebuild`.
+3. Fetch submodules `git submodule init && git submodule update`.
+4. Create a new, descriptively named branch to contain your change ( `git checkout -b my-awesome-feature` ).
+5. Hack away, add tests. Not necessarily in that order.
+6. Make sure everything still passes by running `bundle exec rspec` (see [the tests section](#running-tests-locally) below)
+7. Push the branch up ( `git push origin my-awesome-feature` ).
+8. Create a pull request by visiting `https://github.com/<your-username>/codebuild` and following the instructions at the top of the screen.
+
+## Proposing updates to the documentation
+
+We want the CodeBuild documentation to be the best it can be. We've open-sourced our docs and we welcome any pull requests if you find it lacking.
+
+### How to submit changes
+
+You can find the documentation for [https://codebuild.cloud.com](http://https://codebuild.cloud.com) in the [docs](https://github.com/tongueroo/codebuild/tree/master/docs) directory. See the section above, [submitting a pull request](#submitting-a-pull-request) for information on how to propose a change.
+
+One gotcha, all pull requests should be directed at the `master` branch (the default branch).
+
+## Code Contributions
+
+Interesting in submitting a pull request? Awesome. Read on. There are a few common gotchas that we'd love to help you avoid.
+
+### Tests and documentation
+
+Any time you propose a code change, you should also include updates to the documentation and tests within the same pull request.
+
+#### Documentation
+
+If your contribution changes any CodeBuild behavior, make sure to update the documentation. Documentation lives in the `docs` folder.  It's a Jekyll site and can be started with `cd docs && bin/web`. If the docs are missing information, please feel free to add it in. Great docs make a great project. Include changes to the documentation within your pull request, and once merged, `https://codebuild.cloud.com` will be updated.
+
+#### Tests
+
+* If you're creating a small fix or patch to an existing feature, a simple test is more than enough. You can usually copy/paste from an existing example in the `specs` folder.
+
+### Code contributions generally
+
+* Don't bump the Gem version in your pull request (if you don't know what that means, you probably didn't).
+
+## Running tests
+
+### Test Dependencies
+
+To run the test suite by running the following command:
+
+    bundle exec rspec
+
+## Thank You
+
+Thanks! Hacking on CodeBuild should be fun. If you find any of this hard to figure out, let us know so we can improve our process or documentation!

data/docs/_docs/conventions.md

@@ -0,0 +1,51 @@
+---
+title: Naming Conventions
+nav_order: 9
+---
+
+The codebuild tool follows a few naming conventions.
+
+## Project Name
+
+It will set the codebuild project name by inferring the name of the parent folder.  For example, if the parent folder is `demo`.
+
+    cd demo
+    cb deploy
+
+The CodeBuild project is named `demo`. You can override this easily by providing a project name.
+
+    cd deploy my-project # explicitly use my-project as CodeBuild project name
+
+The CodeBuild project is named `my-project`
+
+## Type Option
+
+If the `--type` option is used, then it is appended to the CodeBuild project name. For example:
+
+    cb deploy my-project --type unit
+
+The CodeBuild project is named `my-project-unit`.
+
+## CB_ENV_EXTRA
+
+The `CB_ENV_EXTRA` also affects the name of the CodeBuild project.  It gets appened after the type option.
+
+    CB_ENV_EXTRA=2 cb deploy my-project --type unit
+
+The CodeBuild project is named `my-project-unit-2`.
+
+## Settings append_env option
+
+If the append_env is configured in the [Settings]({% link _docs/settings.md %}).
+
+## Stack Name
+
+The CloudFormation stack name which creates the CodeBuild related resources is named the same as the project name with `-cb` appended to the stack name. Examples:
+
+CodeBuild Project Name | Stack Name
+--- | ---
+demo | demo-cb
+demo-unit | demo-unit-cb
+demo-web-unit | demo-web-unit-cb
+
+{% include prev_next.md %}

data/docs/_docs/deploy.md

@@ -0,0 +1,69 @@
+---
+title: Deploy
+nav_order: 6
+---
+
+The CodeBuild project is generated from the DSL and created with CloudFormation. By default, the files that the DSL evaluates are:
+
+    .codebuild/buildspec.yml
+    .codebuild/project.rb
+    .codebuild/role.rb
+
+To create the CodeBuild project, you run:
+
+    codebuild deploy
+
+You'll see output that looks something like this:
+
+    $ cb deploy
+    Generated CloudFormation template at /tmp/codebuild.yml
+    Deploying stack demo-cb with CodeBuild project demo
+    Creating stack demo-cb. Check CloudFormation console for status.
+    Stack name demo-cb status CREATE_IN_PROGRESS
+    Here's the CloudFormation url to check for more details https://console.aws.amazon.com/cloudformation/home?region=us-west-2#/stacks
+    Waiting for stack to complete
+    03:04:30AM CREATE_IN_PROGRESS AWS::CloudFormation::Stack demo-cb User Initiated
+    03:04:34AM CREATE_IN_PROGRESS AWS::IAM::Role IamRole
+    03:04:35AM CREATE_IN_PROGRESS AWS::IAM::Role IamRole Resource creation Initiated
+    03:04:54AM CREATE_COMPLETE AWS::IAM::Role IamRole
+    03:04:56AM CREATE_IN_PROGRESS AWS::CodeBuild::Project CodeBuild
+    03:04:58AM CREATE_IN_PROGRESS AWS::CodeBuild::Project CodeBuild Resource creation Initiated
+    03:04:59AM CREATE_COMPLETE AWS::CodeBuild::Project CodeBuild
+    03:05:01AM CREATE_COMPLETE AWS::CloudFormation::Stack demo-cb
+    Stack success status: CREATE_COMPLETE
+    Time took for stack deployment: 30s.
+    $
+
+## Explicit CodeBuild Project Name
+
+By default, the CodeBuild project name is inferred and is the parent folder that you are within.  You can explicitly specify the project name as the first CLI argument:
+
+    cb deploy my-project
+
+## Types
+
+By default, the codebuild tool looks up files in the `.codebuild` folder.  Example:
+
+    .codebuild/buildspec.yml
+    .codebuild/project.rb
+    .codebuild/role.rb
+
+You can use the `--type` option to tell the tool to lookup files in a subfolder.  Here's an example.
+
+    cb deploy PROJECT_NAME --type deploy
+
+This will look up `buildspec.yml`, `project.rb`, and `role.rb` files in the `.codebuild/deploy` folder. So:
+
+    .codebuild/deploy/buildspec.yml
+    .codebuild/deploy/project.rb
+    .codebuild/deploy/role.rb
+
+Likewise `cb deploy PROJECT_NAME --type unit` would result in:
+
+    .codebuild/unit/buildspec.yml
+    .codebuild/unit/project.rb
+    .codebuild/unit/role.rb
+
+Also, for help info you can check the [cb deploy]({% link _reference/codebuild-deploy.md %}) CLI reference.
+
+{% include prev_next.md %}

data/docs/_docs/dsl.md

@@ -0,0 +1,12 @@
+---
+title: CodeBuild DSL
+nav_order: 11
+---
+
+CodeBuild provides a simple yet powerful DSL to create CodeBuild related resources.  Here are some examples of resources it can create:
+
+* [project]({% link _docs/dsl/project.md %}): The CodeBuild project. This is required.
+* [iam role]({% link _docs/dsl/role.md %}): The IAM role associated with the CodeBuild project.
+* [schedule]({% link _docs/dsl/schedule.md %}): An CloudWatch Event rule. The rule triggers the codebuild project to start on a scheduled basis.
+
+{% include prev_next.md %}

data/docs/_docs/dsl/project.md

@@ -0,0 +1,80 @@
+---
+title: Project DSL
+nav_text: Project
+categories: dsl
+nav_order: 12
+---
+
+You define the CodeBuild project in `.codebuild/project.rb`. Here's an example of the DSL used to create a codebuild project.
+
+.codebuild/project.rb:
+
+```ruby
+# 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:
+
+* github_url(url)
+* github_source(options={})
+* linux_image(name)
+* linux_environment(options={})
+* environment_variables(vars)
+* local_cache(enable=true)
+
+Refer to the [dsl/project.rb](https://github.com/tongueroo/codebuild/blob/master/lib/codebuild/dsl/project.rb) source code for the most updated list of methods.
+
+## Full DSL
+
+The convenience methods are shorter and cleaner. However, you have access to a Full DSL if needed. The Full DSL methods are merely the properties of the [AWS::CodeBuild::Project CloudFormation Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html).  Here's an example.
+
+.codebuild/project.rb:
+
+```ruby
+name("demo") # recommend to not set this, and let the codebuild tool set this automatically
+description("desc2")
+# https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html
+source(
+  type: "GITHUB",
+  location: "https://github.com/tongueroo/demo-ufo",
+  git_clone_depth: 1,
+  git_submodules_config: { fetch_submodules: true },
+  build_spec: ".codebuild/buildspec.yml",
+  auth: {
+    type: "OAUTH",
+    resource: ssm("/codebuild/demo/oauth_token"),
+  },
+  report_build_status: true,
+)
+
+artifacts(type: "NO_ARTIFACTS")
+environment(
+  compute_type: "BUILD_GENERAL1_SMALL",
+  image_pull_credentials_type: "CODEBUILD",
+  privileged_mode: true,
+  image: "aws/codebuild/ruby:2.5.3-1.7.0",
+  environment_variables: [
+    {
+      type: "PLAINTEXT",
+      name: "UFO_ENV",
+      value: "development"
+    },
+    {
+      type: "PARAMETER_STORE",
+      name: "API_KEY",
+      value: "/codebuild/demo/api_key"
+    }
+  ],
+  type: "LINUX_CONTAINER"
+)
+
+service_role(ref: "IamRole")
+```
+
+{% include prev_next.md %}