shipyrd 0.2.7 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b1af0b6658cdd0f6103ffe6d9452c82796dfe8ca3f925fd9c15deb3e174a0ef
-  data.tar.gz: cfbda6299a9e7a1b0ef7ab7fd61cd6161c0256a9b1166f7943059112b86cf9e2
+  metadata.gz: 1b988c2350fa48044fbef604ad868571d9730c089725062f120b2b22d3da8e02
+  data.tar.gz: 67b6df1cd737d04ac6c73ca7fcc64843d80cfd26b4e4564a54fbb0dd275b225f
 SHA512:
-  metadata.gz: d4753657fb688e08980ced4d40ed4c86f08da31620978faf63c8f536002cfc917e946709ffd4cec663af662af8d4f384372fa7c780ae8c789d2081ae236318ed
-  data.tar.gz: 7f677cdb4bd4006b548c33daeb9080493e61cbe1bef6dd0ffe08d410d08ba17ae2652f3059ad971cc6abb678e12a9f356f6ef4dcab99c48cf65ace36123e5aee
+  metadata.gz: 9e9813bafcb8a60628689727aafd84e63c47f3a8f1e3f8e533dd56963e70ef915a2c1f2f4cd9ce9d8cd3e02bc4da36477fb4ccd78930a6e30d9896bd2afb23bb
+  data.tar.gz: 20af02a805bd95be735dac9a66b596294b772606f91c8f0ec9a2e82a49754521105a35cd575d6480f04fd188230d491c0d73980973cd616dd3fbc971baf390cb

data/Dockerfile

@@ -0,0 +1,32 @@
+# Use the official Ruby 3.3.0 Alpine image as the base image
+FROM ruby:3.3.0-alpine
+
+# Set the working directory to /shipyrd
+WORKDIR /shipyrd
+
+# Copy the Gemfile, shipyrd.gemspec into the container
+COPY Gemfile shipyrd.gemspec ./
+
+# Required in shipyrd.gemspec
+COPY lib/shipyrd/version.rb /shipyrd/lib/shipyrd/version.rb
+
+# Install system dependencies
+RUN apk add --no-cache --update build-base git \
+    && gem install bundler --version=2.5.14 \
+    && bundle install
+
+# Copy the rest of our application code into the container.
+# We do this after bundle install, to avoid having to run bundle
+# every time we do small fixes in the source code.
+COPY . .
+
+# Install the gem locally from the project folder
+RUN gem build shipyrd.gemspec && \
+    gem install ./shipyrd-*.gem --no-document
+
+# Set the working directory to /workdir
+WORKDIR /workdir
+
+# Tell git it's safe to access /workdir/.git even if
+# the directory is owned by a different user
+RUN git config --global --add safe.directory /workdir

data/README.md

@@ -18,6 +18,24 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 Please see the main Shipyrd app([https://github.com/shipyrd/shipyrd](https://github.com/shipyrd/shipyrd)) for setup and usage instructions.
 
+## Usage with Docker
+
+You can run a dockerized version of `shipyrd-gem` by adding the following function to your `~/.bashrc` or similar:
+
+```bash
+shipyrd() {
+  docker run --rm -v "${PWD}:/workdir" --env-file <(env | grep -E '^(KAMAL_|SHIPYRD_)') ghcr.io/shipyrd/shipyrd-gem /shipyrd/bin/"$@"
+}
+```
+
+Then within a specific Kamal hook (e.g. `pre-connect`), you can call `shipyrd` like this:
+
+```bash
+#!/usr/bin/env bash
+
+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/).
@@ -46,6 +64,14 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/shipyrd/shipyrd-gem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[shipyrd/shipyrd-gem/blob/main/CODE_OF_CONDUCT.md).
 
+## Releasing a new version
+
+The `bin/release` command will bump the version in the version.rb file, tag it, and push it up to github & rubygems.
+
+```
+bin/release 0.2.8
+```
+
 ## Code of Conduct
 
 Everyone interacting in the Shipyrd project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/shipyrd/shipyrd-gem/blob/main/CODE_OF_CONDUCT.md).

data/lib/shipyrd/client.rb

@@ -93,7 +93,7 @@ class Shipyrd::Client
   end
 
   def validate_configuration
-    valid_host? && valid_api_key?
+    valid_api_key?
 
     true
   rescue ArgumentError => e
@@ -102,12 +102,6 @@ class Shipyrd::Client
     false
   end
 
-  def valid_host?
-    raise ArgumentError, "ENV['SHIPYRD_HOST'] is not configured, disabling" unless host
-
-    true
-  end
-
   def valid_api_key?
     raise ArgumentError, "ENV['SHIPYRD_API_KEY'] is not configured, disabling" unless api_key
 
@@ -115,7 +109,7 @@ class Shipyrd::Client
   end
 
   def parse_host(host)
-    return nil unless host
+    return "https://hooks.shipyrd.io" if host.nil?
     return host if host.start_with?("https")
 
     "https://#{host}"

data/lib/shipyrd/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shipyrd
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.9
 platform: ruby
 authors:
 - Nick Hammond
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-31 00:00:00.000000000 Z
+date: 2024-12-03 00:00:00.000000000 Z
 dependencies: []
 description: The companion gem for Shipyrd, the Kamal deployment dashboard
 email:
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - ".standard.yml"
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - Guardfile
 - README.md