shipyrd 0.2.11 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ca8632fd328d206ba4b724f9bc87cfb1da3c91e4c6ef170417e14dad5e4218c
-  data.tar.gz: c2c0d9a4d1e9f523fbbe9fe1f5c42271a38c806951c0eee95f838ff82ec73748
+  metadata.gz: 4dabe0011e5ccdc8b89120b5a9b0a45053b8889b30f18df503a47a6830ac0d05
+  data.tar.gz: 9d6eb3e80786b3d4b2e8d78eb6f661fbc65549c7d06db4be5fbeccce35893bcf
 SHA512:
-  metadata.gz: df11e4e06c89519193752651d55fe33a4e3f8e96b0199c01e08c779b2533f54be89a5d2a10388d85f9c600d5f22f7d7ff5f23f029c7e6b4da63f02623874255c
-  data.tar.gz: 57a15080c8af612d49fb6f7414ba6f542120a39324f5bd2e6e91bd1115f39f909b09b33cbe350ea78135cf49fa355b9bb196f87f6841cfcc123848f18b0eae27
+  metadata.gz: 62220c52b938866e33b67a2927d9b2255687ddd66c04e86415a4d9228cef38e71a3867279e6ea52e00d99b983071d057584417aac050fbfcecbc5848f5cba87b
+  data.tar.gz: b1a59c0ede51edea372bba60512bfe43668063507e07b9040909f6079a3cd10c4d8d6221a6df0362ab175658e97467daed54e441bd359bb2d8dd775e72f59185

data/README.md

@@ -2,7 +2,7 @@
 
 This is a simple helper gem to connect your Kamal hooks(pre-build, pre-build, pre-deploy, post-deploy) to Shipyrd.
 
-[Shipyrd](https://shipyrd.io) is a deployment dashboard built for Kamal.
+[Shipyrd](https://shipyrd.io) is the deployment dashboard for your team.
 
 ## Installation
 
@@ -38,18 +38,18 @@ shipyrd pre-connect
 
 ## Recording a deploy
 
-This gem currently sends the following deploy details to record a deploy. The various `KAMAL_` ENV variables are set via Kamal when the [hooks are called](https://kamal-deploy.org/docs/hooks/hooks-overview/).
-
-* `ENV["KAMAL_COMMAND"]`,
-* `ENV["KAMAL_DESTINATION"]`,
-* `ENV["KAMAL_HOSTS"`,
-* `ENV["KAMAL_PERFORMER"]` - `gh config get -h github.com username` is preferred if set.
-* `ENV["KAMAL_RECORDED_AT"]`,
-* `ENV["KAMAL_ROLE"]`,
-* `ENV["KAMAL_RUNTIME"]`,
-* `ENV["KAMAL_SERVICE_VERSION"]`,
-* `ENV["KAMAL_SUBCOMMAND"]`,
-* `ENV["KAMAL_VERSION"]`,
+This gem currently sends the following deploy details to record a deploy. Each deploy variable can be set with either a `SHIPYRD_` or `KAMAL_` prefix — `SHIPYRD_` takes precedence. The `KAMAL_` variants are set automatically by Kamal when the [hooks are called](https://kamal-deploy.org/docs/hooks/hooks-overview/).
+
+* `ENV["SHIPYRD_COMMAND"]` / `ENV["KAMAL_COMMAND"]`,
+* `ENV["SHIPYRD_DESTINATION"]` / `ENV["KAMAL_DESTINATION"]`,
+* `ENV["SHIPYRD_HOSTS"]` / `ENV["KAMAL_HOSTS"]`,
+* `ENV["SHIPYRD_PERFORMER"]` / `ENV["KAMAL_PERFORMER"]` - `gh config get -h github.com username` is preferred if set.
+* `ENV["SHIPYRD_RECORDED_AT"]` / `ENV["KAMAL_RECORDED_AT"]`,
+* `ENV["SHIPYRD_ROLE"]` / `ENV["KAMAL_ROLE"]`,
+* `ENV["SHIPYRD_RUNTIME"]` / `ENV["KAMAL_RUNTIME"]`,
+* `ENV["SHIPYRD_SERVICE_VERSION"]` / `ENV["KAMAL_SERVICE_VERSION"]`,
+* `ENV["SHIPYRD_SUBCOMMAND"]` / `ENV["KAMAL_SUBCOMMAND"]`,
+* `ENV["SHIPYRD_VERSION"]` / `ENV["KAMAL_VERSION"]`,
 * `ENV["SHIPYRD_API_KEY"]`,
 * `ENV["SHIPYRD_HOST"]`,
 * Commit message - The first 90 characters of your commit message `git show -s --format=%s`.

data/lib/shipyrd/client.rb

@@ -13,8 +13,18 @@ class Shipyrd::Client
     KAMAL_SUBCOMMAND
     KAMAL_VERSION
     SHIPYRD_API_KEY
+    SHIPYRD_COMMAND
     SHIPYRD_COMMIT_MESSAGE
+    SHIPYRD_DESTINATION
     SHIPYRD_HOST
+    SHIPYRD_HOSTS
+    SHIPYRD_PERFORMER
+    SHIPYRD_RECORDED_AT
+    SHIPYRD_ROLE
+    SHIPYRD_RUNTIME
+    SHIPYRD_SERVICE_VERSION
+    SHIPYRD_SUBCOMMAND
+    SHIPYRD_VERSION
   ]
 
   class DestinationBlocked < StandardError; end
@@ -38,17 +48,17 @@ class Shipyrd::Client
     details = {
       deploy: {
         status: event,
-        recorded_at: ENV["KAMAL_RECORDED_AT"],
+        recorded_at: env_var("RECORDED_AT"),
         performer: performer,
         commit_message: ENV["SHIPYRD_COMMIT_MESSAGE"] || commit_message,
-        version: ENV["KAMAL_VERSION"],
-        service_version: ENV["KAMAL_SERVICE_VERSION"],
-        hosts: ENV["KAMAL_HOSTS"],
-        command: ENV["KAMAL_COMMAND"],
-        subcommand: ENV["KAMAL_SUBCOMMAND"],
-        role: ENV["KAMAL_ROLE"],
-        destination: ENV["KAMAL_DESTINATION"],
-        runtime: ENV["KAMAL_RUNTIME"]
+        version: env_var("VERSION"),
+        service_version: env_var("SERVICE_VERSION"),
+        hosts: env_var("HOSTS"),
+        command: env_var("COMMAND"),
+        subcommand: env_var("SUBCOMMAND"),
+        role: env_var("ROLE"),
+        destination: env_var("DESTINATION"),
+        runtime: env_var("RUNTIME")
       }
     }
 
@@ -86,7 +96,7 @@ class Shipyrd::Client
   end
 
   def performer
-    github_username.empty? ? ENV["KAMAL_PERFORMER"] : "https://github.com/#{github_username}"
+    github_username.empty? ? env_var("PERFORMER") : "https://github.com/#{github_username}"
   end
 
   def github_username
@@ -127,4 +137,10 @@ class Shipyrd::Client
 
     "https://#{host}"
   end
+
+  private
+
+  def env_var(name)
+    ENV["SHIPYRD_#{name}"] || ENV["KAMAL_#{name}"]
+  end
 end

data/lib/shipyrd/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Shipyrd
-  VERSION = "0.2.11"
+  VERSION = "0.2.12"
 end

data/shipyrd.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["Nick Hammond"]
   spec.email = ["nick@shipyrd.io"]
 
-  spec.summary = "The companion gem for Shipyrd, the Kamal deployment dashboard"
-  spec.description = "The companion gem for Shipyrd, the Kamal deployment dashboard"
+  spec.summary = "The companion gem for Shipyrd, the deployment dashboard for your team"
+  spec.description = "The companion gem for Shipyrd, the deployment dashboard for your team"
   spec.homepage = "https://shipyrd.io"
   spec.required_ruby_version = ">= 3.0.7"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shipyrd
 version: !ruby/object:Gem::Version
-  version: 0.2.11
+  version: 0.2.12
 platform: ruby
 authors:
 - Nick Hammond
@@ -9,7 +9,7 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description: The companion gem for Shipyrd, the Kamal deployment dashboard
+description: The companion gem for Shipyrd, the deployment dashboard for your team
 email:
 - nick@shipyrd.io
 executables: []
@@ -50,5 +50,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: The companion gem for Shipyrd, the Kamal deployment dashboard
+summary: The companion gem for Shipyrd, the deployment dashboard for your team
 test_files: []