shipyrd 0.2.6 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 733b5eb0bb3ff88170c66bb5b05b07d8462088a022fc458221168c62d6e55a3f
-  data.tar.gz: 02eda7c13d6ae072664de3d151c61bdb6225232ba4854e683e726b11848795d1
+  metadata.gz: fe5022a38929c185905c3cdcbdc369f2c1248ecceeb5bf168851de844b6f4016
+  data.tar.gz: bae76bddedb65ba16f869eaeba93c295854d35e39508794a3f1b274087971970
 SHA512:
-  metadata.gz: 948ea04038276d53bd0d0d0b7d96ba204a7b3caa68a13bded17ee41c5c86164de266074e53092c3adce3e35a23dfbee985345fd0d918c37ec83673bd652a9915
-  data.tar.gz: e82935c40cdef8adcfc66aebb7a145500f6eb27a7ae7cc9e30d4397ced851ba1ee064c024c41e8cffb58eab3c449ef675a3b72edd2f6d0a673134245b77b917a
+  metadata.gz: 9b0e4dcc34ec8273699b4d049a3c5f77e6cbb197b270461dc375445bca062b90ef7fed8b976a89a7608203e28e10c0a0dda0f9404bc561c24f2c1ec07e096eb0
+  data.tar.gz: 59a9bb7a98ae6a4b9de55bf2ac82f6d7a1f2a704e6a0290dfde85ceea1125f52499d356f937214a281ead64e2a67eed24d3dbcabbda07f7e7f34c431719254ef

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

@@ -73,11 +73,15 @@ class Shipyrd::Client
   end
 
   def performer
-    github_username = `gh config get -h github.com username`.chomp
-
     github_username.empty? ? ENV["KAMAL_PERFORMER"] : "https://github.com/#{github_username}"
   end
 
+  def github_username
+    `gh config get -h github.com username`.chomp
+  rescue
+    "" # gh config get returns an empty string when not set
+  end
+
   def commit_message
     message = `git show -s --format=%s`.chomp
 
@@ -112,6 +116,7 @@ class Shipyrd::Client
 
   def parse_host(host)
     return nil unless host
+    return host if host.start_with?("https")
 
     "https://#{host}"
   end

data/lib/shipyrd/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shipyrd
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.8
 platform: ruby
 authors:
 - Nick Hammond
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-29 00:00:00.000000000 Z
+date: 2024-07-08 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