Setup shipyrd-gem Docker image

.github/workflows/docker-publish.yml

@@ -0,0 +1,55 @@
+name: Docker
+
+on:
+  workflow_dispatch:
+    inputs:
+      tagInput:
+        description: 'Tag'
+        required: true
+
+  release:
+    types: [created]
+    tags:
+      - 'v*'
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      -
+        name: Login to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Determine version tag
+        id: version-tag
+        run: |
+          INPUT_VALUE="${{ github.event.inputs.tagInput }}"
+          if [ -z "$INPUT_VALUE" ]; then
+            INPUT_VALUE="${{ github.ref_name }}"
+          fi
+          echo "::set-output name=value::$INPUT_VALUE"
+      -
+        name: Build and push
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: |
+            ghcr.io/shipyrd/shipyrd-gem:latest
+            ghcr.io/shipyrd/shipyrd-gem:${{ steps.version-tag.outputs.value }}

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

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/).

bin/post-deploy

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'shipyrd'
+
+Shipyrd::Client.new.trigger('post-deploy')

bin/pre-build

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'shipyrd'
+
+Shipyrd::Client.new.trigger('pre-build')

bin/pre-connect

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'shipyrd'
+
+Shipyrd::Client.new.trigger('pre-connect')

bin/pre-deploy

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'shipyrd'
+
+Shipyrd::Client.new.trigger('pre-deploy')