shipit-engine 0.30.0 → 0.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a26f88ecb6d3d82e4b537df7cab3cbdd615dc6e2d3663695e18301ccadecb350
-  data.tar.gz: d45d1e8cce82d0b3ec920429474deeae101ffe5bbc8d92272897be8bcef5ca4a
+  metadata.gz: e3fd7ab372e13432986f4bd927df32b97c0d4b969193035d9b34fbb0ce80630d
+  data.tar.gz: 5ac2897e8354b9fbae1f37ab192f2eca26cd4160169295a0ac6706e0b023affe
 SHA512:
-  metadata.gz: 179ad0206a3ca03960bdcf444328a0b6c5c5bbc2ae314f7148365c78edb68380a3e804c6e757f08261f13ca24e0d9c604d0730e3f5c046d6fe2270264ea4195d
-  data.tar.gz: 52db719ed7037625ecec6bb5b31e1a87493cc595e4f8a2a14a65ef7708ca83bebf2193fe0fa82ea33ea9fa11027061f8fade805d4b24fa79c771c6f69ee5c322
+  metadata.gz: ba96ab58f4a67a0658f02bf7844c8a47bf65526bd4dc4d37560a4bab5a9606a12fde8204cbe4f8829c51578bbd815f99e73ca3e3b81559a9935f7c4e4c45da57
+  data.tar.gz: c20e5c8d2a9ff71c70e332760d46e1e9985624411828f39af00754de2dcf50beec0109b22fc48f8669811c2248f52781638a529f8bc5e5083dff41bc54d9266c

data/README.md

@@ -12,7 +12,7 @@ Shipit is compatible with just about anything that you can deploy using a script
 
 This guide aims to help you [set up](#installation-and-setup), [use](#using-shipit), and [understand](#reference) Shipit.
 
-*Shipit requires a database (MySQL, PostgreSQL or SQLite3), redis, and Ruby 2.1 or superior.*
+*Shipit requires a database (MySQL, PostgreSQL or SQLite3), redis, and Ruby 2.6 or superior.*
 
 * * *
 <h2 id="toc">Table of contents</h2>
@@ -35,7 +35,7 @@ This guide aims to help you [set up](#installation-and-setup), [use](#using-ship
 * [Configuring providers](#configuring-providers)
 * [Free samples](/examples/shipit.yml)
 
-**IV. INTERGRATING**
+**IV. INTEGRATING**
 
 * [Registering webhooks](#integrating-webhooks)
 
@@ -130,6 +130,8 @@ Also, if your repository is deployed different ways depending on the environment
 
 For example for a stack like: `my-org/my-repo/staging`, `shipit.staging.yml` will have priority over `shipit.yml`.
 
+Lastly, if you override the `app_name` configuration in your Shipit deployment, `yourapp.yml` and `yourapp.staging.yml` will work.
+
 * * *
 
 <h3 id="installing-dependencies">Installing dependencies</h3>
@@ -268,7 +270,9 @@ deploy:
 ```
 <br>
 
-**<code>deploy.max_commits</code>** defines the maximum number of commits that should be shipped per deploys. Defaults to `8`.
+**<code>deploy.max_commits</code>** defines the maximum number of commits that should be shipped per deploy. Defaults to `8` if no value is provided.
+
+To disable this limit, you can use use an explicit null value: `max_commits: null`. Continuous Delivery will then deploy any number of commits.
 
 Human users will be warned that they are not respecting the recommendation, but allowed to continue.
 However continuous delivery will respect this limit. If there is no deployable commits in this range, a human intervention will be required.
@@ -290,6 +294,15 @@ deploy:
   interval: 5m
 ```
 
+**<code>deploy.retries</code>** enables retries for a stack, and defines the maximum amount of times that Shipit will retry a deploy that finished with a `failed`, `error` or `timedout` status.
+
+For example, this will retry a deploy twice if it fails.
+
+```yaml
+deploy:
+  retries: 2
+```
+
 **<code>rollback.override</code>** contains an array of the shell commands required to rollback the application to a previous state. Shipit will try to infer it from the repository structure, but you can change the default inference. This key defaults to `disabled` unless Capistrano is detected.
 
 For example:
@@ -611,6 +624,8 @@ Your deploy scripts have access to the following environment variables:
 * `SHIPIT`: Set to `1` to allow your script to know it's executed by Shipit
 * `SHIPIT_LINK`: URL to the task output, useful to broadcast it in an IRC channel
 * `SHIPIT_USER`: Full name of the user that triggered the deploy/task
+* `GITHUB_REPO_NAME`: Name of the GitHub repository being used for the current deploy/task.
+* `GITHUB_REPO_OWNER`: The GitHub username of the repository owner for the current deploy/task.
 * `EMAIL`: Email of the user that triggered the deploy/task (if available)
 * `ENVIRONMENT`: The stack environment (e.g `production` / `staging`)
 * `BRANCH`: The stack branch (e.g `master`)
@@ -638,7 +653,7 @@ For Kubernetes, you have to provision Shipit environment with the following tool
 * `kubectl`
 * `kubernetes-deploy` [gem](https://github.com/Shopify/kubernetes-deploy)
 
-<h2 id="integrating">IV. INTERGRATING</h2>
+<h2 id="integrating">IV. INTEGRATING</h2>
 
 <h3 id="integrating-webhooks">Registering webhooks</h3>
 

data/Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
@@ -8,7 +9,7 @@ rescue LoadError
 end
 
 APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
-load 'rails/tasks/engine.rake'
+load('rails/tasks/engine.rake')
 
 Bundler::GemHelper.install_tasks
 
@@ -19,6 +20,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.test_files = FileList.new('test/**/*_test.rb').exclude('test/dummy/**/*')
   t.verbose = false
+  t.warning = false
 end
 
-task default: :test
+task(default: :test)

data/app/assets/images/magic-solid.svg

@@ -0,0 +1 @@
+<svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="magic" class="svg-inline--fa fa-magic fa-w-16" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path fill="currentColor" d="M224 96l16-32 32-16-32-16-16-32-16 32-32 16 32 16 16 32zM80 160l26.66-53.33L160 80l-53.34-26.67L80 0 53.34 53.33 0 80l53.34 26.67L80 160zm352 128l-26.66 53.33L352 368l53.34 26.67L432 448l26.66-53.33L512 368l-53.34-26.67L432 288zm70.62-193.77L417.77 9.38C411.53 3.12 403.34 0 395.15 0c-8.19 0-16.38 3.12-22.63 9.38L9.38 372.52c-12.5 12.5-12.5 32.76 0 45.25l84.85 84.85c6.25 6.25 14.44 9.37 22.62 9.37 8.19 0 16.38-3.12 22.63-9.37l363.14-363.15c12.5-12.48 12.5-32.75 0-45.24zM359.45 203.46l-50.91-50.91 86.6-86.6 50.91 50.91-86.6 86.6z"></path></svg>

data/app/assets/javascripts/shipit/repositories_search.js.coffee

@@ -0,0 +1,60 @@
+KEY =
+  UP: 38
+  DOWN: 40
+  ENTER: 13
+
+class RepositorySearch
+
+  constructor: (root) ->
+    @$root = $(root)
+    @$root.on('keyup', '.repository-search', @onKeyUp)
+    @$root.on('click', '.show-all-repositories', (event) =>
+      @$root.find('.not-matching').removeClass('not-matching')
+      event.preventDefault()
+    )
+
+  onKeyUp: (event) =>
+    @$items = @$root.find('[data-search]')
+    switch event.keyCode
+      when KEY.ENTER
+        event.preventDefault()
+        @goToSelectedRepository()
+      when KEY.UP
+        event.preventDefault()
+        @selectPrevious()
+      when KEY.DOWN
+        event.preventDefault()
+        @selectNext()
+      else
+        @filterResults($.trim($(event.target).val()).toLowerCase())
+
+  filterResults: (query) ->
+    if query
+      for item in @$items
+        $item = $(item)
+        $item.toggleClass('not-matching', query not in $item.attr('data-search').toLowerCase())
+      @selectFirst()
+    else
+      @$items.removeClass('not-matching')
+
+  selectFirst: ->
+    @$items.removeClass('selected').first(':not(.not-matching)').addClass('selected')
+
+  selectNext: ->
+    $next = @$items.filter('.selected').removeClass('selected').nextAll(':not(.not-matching)').first()
+    $next = @$items.filter(':not(.not-matching)').first() unless $next.length
+    $next.addClass('selected')
+
+  selectPrevious: ->
+    $previous = @$items.filter('.selected').removeClass('selected').prevAll(':not(.not-matching)').first()
+    $previous = @$items.filter(':not(.not-matching)').last() unless $previous.length
+    $previous.addClass('selected')
+
+  goToSelectedRepository: ->
+    if repository = @$items.filter('.selected').filter(':not(.not-matching)').find('.commits-path').attr('href')
+      window.location = repository
+
+search = new RepositorySearch(document)
+
+jQuery ->
+  $('.repository-search').focus()

data/app/assets/stylesheets/_pages/_deploy.scss

@@ -196,8 +196,6 @@
   width: 100%;
   overflow-y: auto;
   overflow-x: hidden;
-  padding-right: 20px;
-  padding-left: 15px;
 }
 
 .commit-checks {

data/app/assets/stylesheets/_pages/_repositories.scss

@@ -0,0 +1,148 @@
+.repository-search {
+  -webkit-appearance: none;
+  width: 100%;
+  @extend h1;
+  border: none;
+  font-family: "Helvetica Neue", sans-serif;
+  font-weight: 200;
+  background: asset-data-url('search.svg') no-repeat center right;
+  &::-webkit-input-placeholder {
+    color: #B5C0CA;
+  }
+  &:focus {
+    outline: none;
+    background-image: asset-data-url('search-active.svg');
+  }
+}
+
+.repository-table-header {
+  @include clearfix;
+  margin: 0; padding: 1.25rem 0 1rem;
+  .col {
+    width: 25%;
+    float: left;
+  }
+  li {
+    list-style-type: none;
+    font-size: .875em;
+    color: #BAC5D1;
+  }
+}
+
+.repository-lst {
+  list-style-type: none;
+  margin: 0; padding: 0; margin-bottom: 1.5rem;
+    .col {
+      width: 25%;
+      float: left;
+      text-overflow: ellipsis;
+      white-space: nowrap;
+      overflow: hidden;
+      padding-right: .5rem;
+      box-sizing: border-box;
+    }
+    .undeployed {
+      background-image: asset-data-url('ship.png');
+      background-repeat: no-repeat;
+      background-size: 22px 22px;
+      background-position: 0px center;
+      padding-left: 30px;
+      margin-left: -30px;
+    }
+    .archived {
+      // From FontAwesome, license @ https://fontawesome.com/license/free
+      background-image: asset-data-url('archive-solid.svg');
+      background-repeat: no-repeat;
+      background-size: 22px 22px;
+      background-position: 0px center;
+      padding-left: 30px;
+      margin-left: -30px;
+    }
+    .auto-provisioned {
+      // From FontAwesome, license @ https://fontawesome.com/license/free
+      background-image: asset-data-url('magic-solid.svg');
+      background-repeat: no-repeat;
+      background-size: 22px 22px;
+      background-position: 0px center;
+      padding-left: 30px;
+      margin-left: -30px;
+    }
+}
+
+.repository-lst:empty:before {
+  content: "No environment to deploy to, Shipit Squirrel is displeased";
+}
+
+.repository-lst li {
+  &:nth-child(even) a {
+    background-color: lighten(#EDF1F3, 3.5%);
+  }
+
+  &.selected a {
+    background-color: $blue;
+    outline: none;
+    span { color: #fff; }
+    small { color: rgba(#fff, .8); }
+  }
+
+  a {
+  padding: .35rem;
+  margin-left: -0.35rem; margin-right: -0.35rem;
+  @include clearfix;
+  border-radius: 4px;
+  display: block;
+    &:hover, &:focus {
+      background-color: $blue;
+      outline: none;
+      span { color: #fff; }
+      small { color: rgba(#fff, .8); }
+    }
+  }
+}
+
+.repository-search input {
+  margin-left: 4%;
+  width: 92%;
+  padding: 6px;
+  font-size: larger;
+  -moz-border-radius: 8px;
+  -webkit-border-radius: 8px;
+  border-radius: 8px;
+  outline: 0;
+  border: 1px #a0a0a0 solid;
+}
+
+.repository-search-header {
+  display: none;
+}
+
+.show-all-repositories {
+  display: none;
+}
+
+.filtering-enabled {
+  .show-all-repositories {
+    display: inline-block;
+  }
+
+  .repository-search-header {
+    display: block;
+  }
+  .search-item.not-matching {
+    display: none;
+  }
+}
+
+.new_repository {
+  input.repo {
+    width: 200px;
+    display: inline;
+
+    &:focus {
+      padding-right: 30px !important;
+    }
+  }
+  input:focus {
+    border-color: $blue;
+  }
+}

data/app/assets/stylesheets/_pages/_stacks.scss

@@ -58,6 +58,15 @@
       padding-left: 30px;
       margin-left: -30px;
     }
+    .auto-provisioned {
+      // From FontAwesome, license @ https://fontawesome.com/license/free
+      background-image: asset-data-url('magic-solid.svg');
+      background-repeat: no-repeat;
+      background-size: 22px 22px;
+      background-position: 0px center;
+      padding-left: 30px;
+      margin-left: -30px;
+    }
 }
 
 .stack-lst:empty:before {
@@ -93,9 +102,6 @@
 
 .commits-path {
   font-size: 18px;
-  span {
-    text-transform: capitalize;
-  }
   small {
     font-size: 18px;
     color: #8D9EB0;
@@ -196,6 +202,16 @@
   @include clearfix;
 }
 
+.auto-provisioned {
+  // From FontAwesome, license @ https://fontawesome.com/license/free
+  background-image: asset-data-url('magic-solid.svg');
+  background-repeat: no-repeat;
+  background-size: 22px 22px;
+  background-position: 0px center;
+  padding-left: 30px;
+  margin-left: 5px;
+}
+
 /* STATS */
 
 .stats {

data/app/assets/stylesheets/merge_status.scss

@@ -1,3 +0,0 @@
-.merge-status-container {
-  max-width: 700px;
-}

data/app/assets/stylesheets/shipit.scss

@@ -17,4 +17,5 @@
 @import "_pages/_commits";
 @import "_pages/_settings";
 @import "_pages/_stacks";
+@import "_pages/_repositories";
 @import "_pages/_deploy";

data/app/controllers/concerns/shipit/active_model_serializers_patch.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   module ActiveModelSerializersPatch
     private

data/app/controllers/concerns/shipit/api/cacheable.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   module Api
     module Cacheable

data/app/controllers/concerns/shipit/api/paginable.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 module Shipit
   module Api
     module Paginable
       extend ActiveSupport::Concern
 
-      LINK = 'Link'.freeze
+      LINK = 'Link'
 
       included do
         class_attribute :max_page_size
@@ -12,7 +13,7 @@ module Shipit
 
         self.max_page_size = 100
         self.default_page_size = 30
-        self.default_order = {id: :desc}.freeze
+        self.default_order = { id: :desc }.freeze
       end
 
       private

data/app/controllers/concerns/shipit/api/rendering.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   module Api
     module Rendering
@@ -5,16 +6,16 @@ module Shipit
 
       def render_resources(resources, options = {})
         options[:json] = resources
-        render options
+        render(options)
       end
 
       def render_resource(resource, options = {})
         if resource.destroyed?
-          head :no_content, options.reverse_merge(content_type: 'application/json')
+          head(:no_content, options.reverse_merge(content_type: 'application/json'))
         elsif resource.errors.any?
-          render options.reverse_merge(status: :unprocessable_entity, json: {errors: resource.errors})
+          render(options.reverse_merge(status: :unprocessable_entity, json: { errors: resource.errors }))
         else
-          render options.reverse_merge(json: resource)
+          render(options.reverse_merge(json: resource))
         end
       end
     end