codebuild 0.5.0 → 0.6.0

data/docs/_docs/type-option.md

@@ -0,0 +1,72 @@
+---
+title: Type Option
+nav_order: 4
+---
+
+The `--type` option is a powerful option that allows you to create multiple codebuild projects associated with the same project.
+
+## Default Behavior
+
+By default, the codebuild tool looks up files in the `.codebuild` folder.  Example:
+
+    .codebuild/buildspec.yml
+    .codebuild/project.rb
+    .codebuild/role.rb
+
+You can affect the behavior of the lookup logic with the `--type` option.
+
+## Examples
+
+    cb deploy --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 --type unit` would result in:
+
+    .codebuild/unit/buildspec.yml
+    .codebuild/unit/project.rb
+    .codebuild/unit/role.rb
+
+## Structure
+
+So if you need multiple CodeBuild projects that perform different tasks but are both related to the same code repo, this structure is useful:
+
+    .codebuild
+    ├── deploy
+    │   ├── buildspec.yml
+    │   ├── project.rb
+    │   ├── role.rb
+    │   └── schedule.rb
+    └── unit
+        ├── buildspec.yml
+        ├── project.rb
+        ├── role.rb
+        └── schedule.rb
+
+## Code Project Name
+
+The CloudFormation stack name is appended with the name of the type option. So if your project folder is `demo` and the type option is `unit`.
+
+    cd demo # project folder
+    cb deploy --type unit
+
+It produces a CodeBuild project named `demo-unit`.  The project name is an optional first CLI argument. Here's an example:
+
+    cd demo # project folder
+    cb deploy demo-web --type deploy # CodeProject name: demo-web-deploy
+
+## Stack Name
+
+The stack name is the same as the CodeBuild project name with the `-cb` suffix appended to it.  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/variables.md

@@ -0,0 +1,90 @@
+---
+title: Variables Support
+nav_order: 5
+---
+
+The codebuild tool supports the concept of variables. Variables allow you to set environment-specific variables. For example, development and production environments usually require the same code but use different variables.
+
+Within the `.codebuild/variables` folder, you can create variable files and the variables defined in them are made available to your `.codebuild` DSL files.  Examples:
+
+    .codebuild/project.rb
+    .codebuild/role.rb
+    .codebuild/schedule.rb
+
+## Structure
+
+Here's an example variables structure:
+
+    .codebuild
+    └── variables
+        ├── base.rb
+        ├── development.rb
+        └── production.rb
+
+## Layering Support
+
+The variable files are layered together. The `base.rb` and specific `CB_ENV `variable file, like `development.rb`, are combined. An example helps explain.   Let's say you have these files:
+
+base.rb:
+
+```ruby
+@myvar = "base-value"
+```
+
+development.rb:
+
+```ruby
+@myvar = "development-value"
+```
+
+production.rb:
+
+```ruby
+@myvar = "production-value"
+```
+
+Then you can do this:
+
+    cb deploy # defaults to CB_ENV=development
+
+Since `CB_ENV=development` is the default, this means `@myvar = "development-value"` is used.
+
+If we want to use production values, then we can set `CB_ENV=production`
+
+    CB_ENV=production cb deploy
+
+In this case, `@myvar = "production-value"` is used.
+
+Now if we use `CB_ENV=staging`
+
+    CB_ENV=staging cb deploy
+
+In this case, `@myvar = "base-value"` is used, since there is no `staging.rb` file.
+
+## Variables with -\-type Option
+
+With codebuild, we can use a `--type` option to create additional codebuild projects under the `.codebuild` folder.  Here's a short example:
+
+    cb deploy --type deploy
+
+The buildspec file it'll use is here:
+
+    .codebuild/deploy/buildspec.yml
+
+More info on the type option is here: [Type Option]({% link _docs/type-option.md %}).
+
+Specific project type variables can be set. For example, let's say you have a `--type=deploy`, the variable files that will be used are:
+
+    .codebuild/deploy/variables/base.rb
+    .codebuild/deploy/variables/developemnt.rb
+
+The type specific variable files override the top-level variable files. Type specific variable files get loaded last so they take the highest precedence.  Example:
+
+    .codebuild/variables/base.rb - lowest precedence
+    .codebuild/variables/developemnt.rb
+    .codebuild/deploy/variables/base.rb
+    .codebuild/deploy/variables/developemnt.rb - highest precedence
+
+The top-level variables files are also loaded because it is common to need variables that are available to all projects.
+
+{% include prev_next.md %}

data/docs/_includes/commands.html

@@ -0,0 +1,86 @@
+    <section class="features" id="features">
+        <div class="container">
+            <div class="section-heading text-center">
+                <h2>The Code</h2>
+                <p class="text-muted">Easy to learn</p>
+                <hr>
+            </div>
+            <div class="row">
+                <div class="col-lg-12">
+                    <div class="container-fluid">
+                        <div class="row">
+                            <div class="col-lg-6">
+                                <h3>Overview</h3>
+                                <div class="commands">
+{% highlight sh %}
+cb init
+cb deploy
+cb start
+cb delete
+{% endhighlight %}
+                                </div>
+                            </div>
+                            <div class="col-lg-6">
+                                <h3>Structure</h3>
+                                <div class="commands">
+{% highlight sh %}
+.codebuild
+├── buildspec.yml
+├── role.rb
+├── project.rb
+└── schedule.rb
+{% endhighlight %}
+                                </div>
+                            </div>
+                        </div>
+                        <div class="row">
+                            <div class="col-lg-6">
+                                <h3>Usage</h3>
+                                <div class="commands">
+{% highlight sh %}
+cb deploy # infers the CloudFormation name from the parent folder
+cb deploy stack-name # explicitly specify stack name
+
+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
+{% endhighlight %}
+                                </div>
+                            </div>
+                            <div class="col-lg-6">
+                                <h3>project.rb</h3>
+                                <div class="commands">
+{% highlight ruby %}
+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
+)
+{% endhighlight %}
+                                </div>
+                            </div>
+                        </div>
+                        <div class="row">
+                            <div class="col-lg-6">
+                                <h3>role.rb</h3>
+                                <div class="commands">
+{% highlight ruby %}
+iam_policy("logs", "ssm")
+{% endhighlight %}
+                                </div>
+                            </div>
+                            <div class="col-lg-6">
+                                <h3>schedule.rb</h3>
+                                <div class="commands">
+{% highlight ruby %}
+rate "1 day"
+{% endhighlight %}
+                                </div>
+                            </div>
+                        </div>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </section>

data/docs/_includes/content.html

@@ -0,0 +1,25 @@
+{% if page.subnav == false %}
+
+    {{ content }}
+
+{% else %}
+
+    <section class="features" id="features">
+        <div class="container">
+            <div class="row">
+                {% if page.reference %}
+                <div class="col-md-9 reference-nav">
+                    <a href="/reference">Back to Reference Index</a>
+                </div>
+                {% endif %}
+                <div class="col-md-9 content-body">
+                    <h1>{{ page.title }}</h1>
+                    {{ content }}
+                    {% include edit-on-github.html %}
+                </div>
+                {% include subnav.html %}
+            </div>
+        </div>
+    </section>
+
+{% endif %}

data/docs/_includes/edit-on-github.html

@@ -0,0 +1,9 @@
+<div class="edit-on-github">
+  <h2>Edit this page</h2>
+  <p>See a typo or an error? You can improve this page. This website is available on <a href="{{ site.gh_url }}">GitHub</a>, and contributions are encouraged and welcomed. We love pull requests from you! </p>
+  <ul>
+    <li><a href="{{ site.gh_url }}/blob/master/docs/{{ page.path }}" target="_blank">Suggest an edit to this page</a> (here's the <a href="{% link _docs/contributing.md %}" target="_blank">contributing guide</a>).</li>
+    <li><a href="{{ site.gh_url }}/issues/new?body=This%20issue%20is%20about%20<http://{{ site.url }}{{ page.url }}>%20(source%20file%3A%20<{{ site.gh_url }}/blob/master/docs/{{ page.path }}>)" target="_blank">Open an issue about this page</a> to report a
+      problem.</li>
+  </ul>
+</div>

data/docs/_includes/footer.html

@@ -0,0 +1,41 @@
+    <footer class="text-center">
+        <div class="footer-above">
+            <div class="container">
+                <div class="row">
+                    <div class="footer-col col-md-4">
+                        <h3>More Tools</h3>
+                        <ul class="list-unstyled tools">
+                            <li><a href="https://rubyonjets.com">Jets</a></li>
+                            <li><a href="https://ufoships.com">Ufo</a></li>
+                            <li><a href="https://lono.cloud">Lono</a></li>
+                            <li><a href="https://sonic-screwdriver.cloud">Sonic</a></li>
+                            <li><a href="https://jack-eb.com">Jack</a></li>
+                        </ul>
+                    </div>
+                    <div class="footer-col col-md-4">
+                        <h3><a href="https://boltops.com"><img class="footer-logo" src="/img/logos/boltops-logo-full.png" /></a></h3>
+                        <ul class="list-inline">
+                            {% for network in site.social %}
+                            <li>
+                                <a href="{{ network.url }}" class="btn-social btn-outline"><i class="fa fa-fw fa-{{ network.title }}"></i></a>
+                            </li>
+                        {% endfor %}
+                        </ul>
+                    </div>
+                    <div class="footer-col col-md-4">
+                        <h3>Contact</h3>
+                        <p>{{ site.footer.contact }}</p>
+                        <p>{{ site.footer.phone }}</p>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </footer>
+
+    <footer>
+        <div class="container">
+            <div class="footer-below">
+            <p>Maintained by {{ site.footer.copyright }}  20{{ site.time | date: '%y' }}</p>
+            </div>
+        </div>
+    </footer>

data/docs/_includes/google_analytics.html

@@ -0,0 +1,10 @@
+<!-- Google analytics -->
+<script>
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+  ga('create', '{{ site.google_analytics }}', 'auto');
+  ga('send', 'pageview');
+</script>

data/docs/_includes/head.html

@@ -0,0 +1,45 @@
+<head>
+
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <meta name="description" content="">
+    <meta name="author" content="">
+
+    {% if page.title %}
+    <title>{{ page.title }} - {{ site.title }}</title>
+    {% else %}
+    <title>CodeBuild DSL</title>
+    {% endif %}
+
+    <meta name="description" content="{{ site.description }}">
+    <meta name="keywords" content="{{ site.keywords }}" />
+    {% if site.meta_author %}<meta name="author" content="{{ site.meta_author }}">{% endif %}
+    <link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: site.url }}">
+
+    <!-- Bootstrap core CSS -->
+    <link href="/vendor/bootstrap/css/bootstrap.min.css" rel="stylesheet">
+
+    <!-- Custom fonts for this template -->
+    <link rel="stylesheet" href="/vendor/font-awesome/css/font-awesome.min.css">
+    <link rel="stylesheet" href="/vendor/simple-line-icons/css/simple-line-icons.css">
+    <link href="https://fonts.googleapis.com/css?family=Lato" rel="stylesheet">
+    <link href="https://fonts.googleapis.com/css?family=Catamaran:100,200,300,400,500,600,700,800,900" rel="stylesheet">
+    <link href="https://fonts.googleapis.com/css?family=Muli" rel="stylesheet">
+
+    <!-- Custom styles for this template -->
+    <link href="/new-age.css" rel="stylesheet">
+
+    <!-- Temporary navbar container fix -->
+    <style>
+    .navbar-toggler {
+        z-index: 1;
+    }
+
+    @media (max-width: 576px) {
+        nav > .container {
+            width: 100%;
+        }
+    }
+    </style>
+
+</head>

data/docs/_includes/js.html

@@ -0,0 +1,18 @@
+    <!-- Bootstrap core JavaScript -->
+    <script src="/vendor/jquery/jquery.min.js"></script>
+    <script src="/vendor/tether/tether.min.js"></script>
+    <script src="/vendor/bootstrap/js/bootstrap.min.js"></script>
+
+    <!-- Plugin JavaScript -->
+    <script src="/vendor/jquery-easing/jquery.easing.min.js"></script>
+
+    <!-- Custom scripts for this template -->
+    <script src="/js/new-age.min.js"></script>
+    <script src="/js/nav.js"></script>
+
+    {% if site.google_analytics and jekyll.environment == "production" %}
+    {% include google_analytics.html %}
+    {% endif %}
+
+    <div id="codefund"><!-- fallback content --></div>
+    <script src="https://codefund.app/properties/177/funder.js" async="async"></script>

data/docs/_includes/nav.html

@@ -0,0 +1,17 @@
+    <!-- Navigation -->
+    <nav class="navbar fixed-top navbar-toggleable-md navbar-light" id="mainNav">
+        <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarExample" aria-controls="navbarExample" aria-expanded="false" aria-label="Toggle navigation">
+            Menu <i class="fa fa-bars"></i>
+        </button>
+        <div class="container">
+            <a class="navbar-brand" href="/#page-top"><img class="navbar-logo" src="/img/logos/project-logo.png" />CodeBuild</a>
+            <div class="collapse navbar-collapse" id="navbarExample">
+                <ul class="navbar-nav ml-auto">
+                    <li class="nav-item"><a class="nav-link" href="{% link quick-start.md %}">Quick Start</a></li>
+                    <li class="nav-item"><a class="nav-link" href="{% link docs.md %}">Docs</a></li>
+                    <li class="nav-item"><a class="nav-link" href="{% link support.md %}">Support</a></li>
+                    <li class="nav-item"><a class="nav-link" href="https://github.com/tongueroo/codebuild">GitHub</a></li>
+                </ul>
+            </div>
+        </div>
+    </nav>

data/docs/_includes/prev_next.md

@@ -0,0 +1,19 @@
+{% assign all_pages = site.pages | concat: site.docs | where_exp: "item", "item.nav_order" %}
+{% assign links = all_pages | sort: "nav_order" %}
+{% for link in links %}
+	{% if link.url == page.url %}
+		{% unless forloop.first %}
+			{% assign prev = tmpprev %}
+		{% endunless %}
+		{% if forloop.last %}
+		  {% assign last = "/reference" %}
+		{% else %}
+			{% assign next = links[forloop.index] %}
+		{% endif %}
+	{% endif %}
+	{% assign tmpprev = link %}
+{% endfor %}
+
+{% if prev %}<a id="prev" class="btn btn-basic" href="{{ prev.url }}">Back</a>{% endif %}{% if last %}<a id="next" class="btn btn-primary" href="/reference">Next Step</a>{% endif %}
+{% if next %}<a id="next" class="btn btn-primary" href="{{ next.url }}">Next Step</a>{% endif %}
+<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>