shipyrd 0.2.10 → 0.2.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/README.md +13 -13
  4. data/lib/shipyrd/client.rb +28 -11
  5. data/lib/shipyrd/version.rb +1 -1
  6. data/shipyrd.gemspec +2 -2
  7. metadata +4 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5074f6113c81db3167ce573cc244a07b1da3d0fe382b61096cd33584fec5bbd8
4
- data.tar.gz: c416cc50aa7a85cceb80ee7196fe3eea802901bc5ae01f0a1d5ecae53695f413
3
+ metadata.gz: 4dabe0011e5ccdc8b89120b5a9b0a45053b8889b30f18df503a47a6830ac0d05
4
+ data.tar.gz: 9d6eb3e80786b3d4b2e8d78eb6f661fbc65549c7d06db4be5fbeccce35893bcf
5
5
  SHA512:
6
- metadata.gz: 510145a48a04599f50ea8c345de79920c6ce6d744179ff3fa80564e2d247294318fd0e9fd153455a85e28e9f62b942a7a7f5e4bae2f749dde48be14bff61d9fa
7
- data.tar.gz: 68ce310175914a76103f37b63ab790026f6ec5277a9f25c2819f14a48a34cf30a196b5abb86360fd596c5017bb96a4401ec388ad7afebe9d478e60f6e410e678
6
+ metadata.gz: 62220c52b938866e33b67a2927d9b2255687ddd66c04e86415a4d9228cef38e71a3867279e6ea52e00d99b983071d057584417aac050fbfcecbc5848f5cba87b
7
+ data.tar.gz: b1a59c0ede51edea372bba60512bfe43668063507e07b9040909f6079a3cd10c4d8d6221a6df0362ab175658e97467daed54e441bd359bb2d8dd775e72f59185
data/Gemfile CHANGED
@@ -12,6 +12,6 @@ gem "guard-standardrb", "~> 0.2"
12
12
  gem "minitest", "~> 5.20"
13
13
  gem "minitest-reporters", "~> 1.3"
14
14
  gem "minitest-silence"
15
- gem "mocha", "~> 3.0.1"
15
+ gem "mocha", "~> 3.1.0"
16
16
  gem "rake", "~> 13.0"
17
17
  gem "webmock", "~> 3.23"
data/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  This is a simple helper gem to connect your Kamal hooks(pre-build, pre-build, pre-deploy, post-deploy) to Shipyrd.
4
4
 
5
- [Shipyrd](https://shipyrd.io) is a deployment dashboard built for Kamal.
5
+ [Shipyrd](https://shipyrd.io) is the deployment dashboard for your team.
6
6
 
7
7
  ## Installation
8
8
 
@@ -38,18 +38,18 @@ shipyrd pre-connect
38
38
 
39
39
  ## Recording a deploy
40
40
 
41
- 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/).
42
-
43
- * `ENV["KAMAL_COMMAND"]`,
44
- * `ENV["KAMAL_DESTINATION"]`,
45
- * `ENV["KAMAL_HOSTS"`,
46
- * `ENV["KAMAL_PERFORMER"]` - `gh config get -h github.com username` is preferred if set.
47
- * `ENV["KAMAL_RECORDED_AT"]`,
48
- * `ENV["KAMAL_ROLE"]`,
49
- * `ENV["KAMAL_RUNTIME"]`,
50
- * `ENV["KAMAL_SERVICE_VERSION"]`,
51
- * `ENV["KAMAL_SUBCOMMAND"]`,
52
- * `ENV["KAMAL_VERSION"]`,
41
+ 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/).
42
+
43
+ * `ENV["SHIPYRD_COMMAND"]` / `ENV["KAMAL_COMMAND"]`,
44
+ * `ENV["SHIPYRD_DESTINATION"]` / `ENV["KAMAL_DESTINATION"]`,
45
+ * `ENV["SHIPYRD_HOSTS"]` / `ENV["KAMAL_HOSTS"]`,
46
+ * `ENV["SHIPYRD_PERFORMER"]` / `ENV["KAMAL_PERFORMER"]` - `gh config get -h github.com username` is preferred if set.
47
+ * `ENV["SHIPYRD_RECORDED_AT"]` / `ENV["KAMAL_RECORDED_AT"]`,
48
+ * `ENV["SHIPYRD_ROLE"]` / `ENV["KAMAL_ROLE"]`,
49
+ * `ENV["SHIPYRD_RUNTIME"]` / `ENV["KAMAL_RUNTIME"]`,
50
+ * `ENV["SHIPYRD_SERVICE_VERSION"]` / `ENV["KAMAL_SERVICE_VERSION"]`,
51
+ * `ENV["SHIPYRD_SUBCOMMAND"]` / `ENV["KAMAL_SUBCOMMAND"]`,
52
+ * `ENV["SHIPYRD_VERSION"]` / `ENV["KAMAL_VERSION"]`,
53
53
  * `ENV["SHIPYRD_API_KEY"]`,
54
54
  * `ENV["SHIPYRD_HOST"]`,
55
55
  * Commit message - The first 90 characters of your commit message `git show -s --format=%s`.
data/lib/shipyrd/client.rb CHANGED
@@ -13,7 +13,18 @@ class Shipyrd::Client
13
13
  KAMAL_SUBCOMMAND
14
14
  KAMAL_VERSION
15
15
  SHIPYRD_API_KEY
16
+ SHIPYRD_COMMAND
17
+ SHIPYRD_COMMIT_MESSAGE
18
+ SHIPYRD_DESTINATION
16
19
  SHIPYRD_HOST
20
+ SHIPYRD_HOSTS
21
+ SHIPYRD_PERFORMER
22
+ SHIPYRD_RECORDED_AT
23
+ SHIPYRD_ROLE
24
+ SHIPYRD_RUNTIME
25
+ SHIPYRD_SERVICE_VERSION
26
+ SHIPYRD_SUBCOMMAND
27
+ SHIPYRD_VERSION
17
28
  ]
18
29
 
19
30
  class DestinationBlocked < StandardError; end
@@ -37,17 +48,17 @@ class Shipyrd::Client
37
48
  details = {
38
49
  deploy: {
39
50
  status: event,
40
- recorded_at: ENV["KAMAL_RECORDED_AT"],
51
+ recorded_at: env_var("RECORDED_AT"),
41
52
  performer: performer,
42
- commit_message: commit_message,
43
- version: ENV["KAMAL_VERSION"],
44
- service_version: ENV["KAMAL_SERVICE_VERSION"],
45
- hosts: ENV["KAMAL_HOSTS"],
46
- command: ENV["KAMAL_COMMAND"],
47
- subcommand: ENV["KAMAL_SUBCOMMAND"],
48
- role: ENV["KAMAL_ROLE"],
49
- destination: ENV["KAMAL_DESTINATION"],
50
- runtime: ENV["KAMAL_RUNTIME"]
53
+ commit_message: ENV["SHIPYRD_COMMIT_MESSAGE"] || commit_message,
54
+ version: env_var("VERSION"),
55
+ service_version: env_var("SERVICE_VERSION"),
56
+ hosts: env_var("HOSTS"),
57
+ command: env_var("COMMAND"),
58
+ subcommand: env_var("SUBCOMMAND"),
59
+ role: env_var("ROLE"),
60
+ destination: env_var("DESTINATION"),
61
+ runtime: env_var("RUNTIME")
51
62
  }
52
63
  }
53
64
 
@@ -85,7 +96,7 @@ class Shipyrd::Client
85
96
  end
86
97
 
87
98
  def performer
88
- github_username.empty? ? ENV["KAMAL_PERFORMER"] : "https://github.com/#{github_username}"
99
+ github_username.empty? ? env_var("PERFORMER") : "https://github.com/#{github_username}"
89
100
  end
90
101
 
91
102
  def github_username
@@ -126,4 +137,10 @@ class Shipyrd::Client
126
137
 
127
138
  "https://#{host}"
128
139
  end
140
+
141
+ private
142
+
143
+ def env_var(name)
144
+ ENV["SHIPYRD_#{name}"] || ENV["KAMAL_#{name}"]
145
+ end
129
146
  end
data/lib/shipyrd/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Shipyrd
4
- VERSION = "0.2.10"
4
+ VERSION = "0.2.12"
5
5
  end
data/shipyrd.gemspec CHANGED
@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
8
8
  spec.authors = ["Nick Hammond"]
9
9
  spec.email = ["nick@shipyrd.io"]
10
10
 
11
- spec.summary = "The companion gem for Shipyrd, the Kamal deployment dashboard"
12
- spec.description = "The companion gem for Shipyrd, the Kamal deployment dashboard"
11
+ spec.summary = "The companion gem for Shipyrd, the deployment dashboard for your team"
12
+ spec.description = "The companion gem for Shipyrd, the deployment dashboard for your team"
13
13
  spec.homepage = "https://shipyrd.io"
14
14
  spec.required_ruby_version = ">= 3.0.7"
15
15
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: shipyrd
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.10
4
+ version: 0.2.12
5
5
  platform: ruby
6
6
  authors:
7
7
  - Nick Hammond
@@ -9,7 +9,7 @@ bindir: bin
9
9
  cert_chain: []
10
10
  date: 1980-01-02 00:00:00.000000000 Z
11
11
  dependencies: []
12
- description: The companion gem for Shipyrd, the Kamal deployment dashboard
12
+ description: The companion gem for Shipyrd, the deployment dashboard for your team
13
13
  email:
14
14
  - nick@shipyrd.io
15
15
  executables: []
@@ -48,7 +48,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
48
48
  - !ruby/object:Gem::Version
49
49
  version: '0'
50
50
  requirements: []
51
- rubygems_version: 4.0.0
51
+ rubygems_version: 3.6.9
52
52
  specification_version: 4
53
- summary: The companion gem for Shipyrd, the Kamal deployment dashboard
53
+ summary: The companion gem for Shipyrd, the deployment dashboard for your team
54
54
  test_files: []