shipit-engine 0.28.1 → 0.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1e854d10e7f525e0a9af5a02bfb432ae6cd091079a8adae14894fc2e42415f2
-  data.tar.gz: 250798a87f4662d2a13e01090a31f4fc3bf82df6b206468002ca5098c792d951
+  metadata.gz: 47bb069ae71eaf994a57ee8dbe3a409adf62ede12fbb010b18ffb9056cee9e0e
+  data.tar.gz: 2e8399c7f72ed1308de6b0be4715579bb6732f3759b22eb38e2e750bb84439de
 SHA512:
-  metadata.gz: 8872ae9ba8ed5dcbf9de6dca1d46d40f87d9b870a5927e4b31ab62f794713b9ec030f4b8e13cf344ab2fc588d501e6d35532f13019f70815247a11fdfac0e8c8
-  data.tar.gz: 146fc5d4fec1d577d5b49bbee57b3dc9d9f391522be6e6f8877dcf80b62438eafa908454439124843ba5034e96afaaae93632b3e61f8ef1211542d297d7a4666
+  metadata.gz: a0a8986aae58f932aca14da3213df881dabfa1017aa844bfe3f5a61afcabc2f09032eafe4342d8acdb7d4fc50cfe4ec9ad1f05dba9209757ef95cc6aa8c8a142
+  data.tar.gz: 0722dfd987d98c176b4625e23921c5576b1a40e85ed6e4d18208c4a4eff4b8c45ba314055dee3255feb576748431be638e6eb97fda6935c6953b70bfe6f14048

data/README.md

@@ -35,7 +35,11 @@ This guide aims to help you [set up](#installation-and-setup), [use](#using-ship
 * [Configuring providers](#configuring-providers)
 * [Free samples](/examples/shipit.yml)
 
-**IV. CONTRIBUTING**
+**IV. INTEGRATING**
+
+* [Registering webhooks](#integrating-webhooks)
+
+**V. CONTRIBUTING**
 
 * [Instructions](#contributing-instructions)
 * [Local development](#contributing-local-dev)
@@ -126,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>
@@ -607,6 +613,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`)
@@ -634,7 +642,36 @@ For Kubernetes, you have to provision Shipit environment with the following tool
 * `kubectl`
 * `kubernetes-deploy` [gem](https://github.com/Shopify/kubernetes-deploy)
 
-<h2 id="contributing">IV. CONTRIBUTING</h2>
+<h2 id="integrating">IV. INTEGRATING</h2>
+
+<h3 id="integrating-webhooks">Registering webhooks</h3>
+
+Shipit handles several webhook types by default, listed in `Shipit::Wehbooks::DEFAULT_HANDLERS`, in order to implement default behaviours. Extra handler blocks can be registered via `Shipit::Webhooks.register_handler`. Valid handlers need only implement the `call` method - meaning any object which implements `call` - blocks, procs, or lambdas are valid. The webhooks controller will pass a `params` argument to the handler. Some examples:
+
+
+<h4>Registering a Plain old Ruby Object as a handler</h4>
+
+```ruby
+class PullRequestHandler
+  def call(params)
+    # do something with pull request webhook events
+  end
+end
+
+Shipit::Webhooks.register_handler('pull_request', PullRequestHandler)
+```
+
+<h4>Registering a Block as a handler</h4>
+
+```ruby
+Shipit::Webhooks.register_handler('pull_request') do |params|
+  # do something with pull request webhook events
+end
+```
+
+Multiple handler blocks can be registered. If any raise errors, execution will be halted and the request will be reported failed to github.
+
+<h2 id="contributing">V. CONTRIBUTING</h2>
 
 <h3 id="contributing-instructions">Instructions</h3>
 
@@ -657,3 +694,5 @@ Run `./bin/bootstrap` in order to bootstrap the dummy application. The bootstrap
 Run `./test/dummy/bin/rails server` to run the rails dummy application.
 
 Set the environment variable `SHIPIT_DISABLE_AUTH=1` in order to disable authentication.
+
+If you need to test caching behaviour in the dummy application, use `bin/rails dev:cache`.

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/archive-solid.svg

@@ -0,0 +1 @@
+<svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="archive" class="svg-inline--fa fa-archive fa-w-16" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path fill="currentColor" d="M32 448c0 17.7 14.3 32 32 32h384c17.7 0 32-14.3 32-32V160H32v288zm160-212c0-6.6 5.4-12 12-12h104c6.6 0 12 5.4 12 12v8c0 6.6-5.4 12-12 12H204c-6.6 0-12-5.4-12-12v-8zM480 32H32C14.3 32 0 46.3 0 64v48c0 8.8 7.2 16 16 16h480c8.8 0 16-7.2 16-16V64c0-17.7-14.3-32-32-32z"></path></svg>

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/_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

@@ -49,6 +49,24 @@
       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;
+    }
 }
 
 .stack-lst:empty:before {
@@ -84,9 +102,6 @@
 
 .commits-path {
   font-size: 18px;
-  span {
-    text-transform: capitalize;
-  }
   small {
     font-size: 18px;
     color: #8D9EB0;
@@ -161,3 +176,80 @@
 .pagination {
   text-align: center;
 }
+
+.box {
+  border-radius: 5px;
+  width: 32%;
+  float: left;
+  padding: 5px;
+}
+
+.box__header {
+  padding: 15px 25px;
+  position: relative;
+}
+
+.box__header-title {
+  color: #333;
+  font-size: 18px;
+}
+
+.box__body {
+  padding: 0 25px;
+}
+
+.row {
+  @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 {
+  color: #333;
+  position: relative;
+  padding-bottom: 25px;
+}
+
+.stats__amount {
+  font-size: 54px;
+  line-height: 1.2;
+}
+
+.stats__caption {
+  font-size: 18px;
+
+}
+
+.stats__change {
+  position: absolute;
+  top: 10px;
+  right: 0;
+  text-align: right;
+  color: #B1B7C8;
+}
+
+.stats__value {
+  font-size: 18px;
+}
+
+.stats__period {
+  font-size: 14px;
+}
+
+.stats__value--positive {
+  color: #AEDC6F;
+}
+
+.stats__value--negative {
+  color: #FB5055;
+}

data/app/assets/stylesheets/merge_status.scss

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