{"id":48798883,"url":"https://github.com/shipyrd/shipyrd-gem","last_synced_at":"2026-04-14T01:00:29.851Z","repository":{"id":242123028,"uuid":"666152190","full_name":"Shipyrd/shipyrd-gem","owner":"Shipyrd","description":"The companion gem for Shipyrd, the Kamal deployment dashboard","archived":false,"fork":false,"pushed_at":"2026-02-05T19:50:02.000Z","size":59,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-05T05:58:21.153Z","etag":null,"topics":["kamal","ruby"],"latest_commit_sha":null,"homepage":"https://shipyrd.io","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Shipyrd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-07-13T20:50:30.000Z","updated_at":"2026-02-05T19:50:05.000Z","dependencies_parsed_at":null,"dependency_job_id":"319a4b86-02d1-4f07-a338-3cb2f9ea0d2e","html_url":"https://github.com/Shipyrd/shipyrd-gem","commit_stats":null,"previous_names":["shipyrd/shipyrd-gem"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/Shipyrd/shipyrd-gem","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Shipyrd%2Fshipyrd-gem","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Shipyrd%2Fshipyrd-gem/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Shipyrd%2Fshipyrd-gem/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Shipyrd%2Fshipyrd-gem/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Shipyrd","download_url":"https://codeload.github.com/Shipyrd/shipyrd-gem/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Shipyrd%2Fshipyrd-gem/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31774587,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-13T20:17:16.280Z","status":"ssl_error","status_checked_at":"2026-04-13T20:17:08.216Z","response_time":93,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["kamal","ruby"],"created_at":"2026-04-14T01:00:19.440Z","updated_at":"2026-04-14T01:00:29.824Z","avatar_url":"https://github.com/Shipyrd.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Shipyrd\n\nThis is a simple helper gem to connect your Kamal hooks(pre-build, pre-build, pre-deploy, post-deploy) to Shipyrd.\n\n[Shipyrd](https://shipyrd.io) is a deployment dashboard built for Kamal.\n\n## Installation\n\nInstall the gem and add to the application's Gemfile by executing:\n\n    $ bundle add shipyrd\n\nIf bundler is not being used to manage dependencies, install the gem by executing:\n\n    $ gem install shipyrd\n\n## Usage\n\nPlease see the main Shipyrd app([https://github.com/shipyrd/shipyrd](https://github.com/shipyrd/shipyrd)) for setup and usage instructions.\n\n## Usage with Docker\n\nYou can run a dockerized version of `shipyrd-gem` by adding the following function to your `~/.bashrc` or similar:\n\n```bash\nshipyrd() {\n  docker run --rm -v \"${PWD}:/workdir\" --env-file \u003c(env | grep -E '^(KAMAL_|SHIPYRD_)') ghcr.io/shipyrd/shipyrd-gem /shipyrd/bin/\"$@\"\n}\n```\n\nThen within a specific Kamal hook (e.g. `pre-connect`), you can call `shipyrd` like this:\n\n```bash\n#!/usr/bin/env bash\n\nshipyrd pre-connect\n```\n\n## Recording a deploy\n\nThis 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/).\n\n* `ENV[\"KAMAL_COMMAND\"]`,\n* `ENV[\"KAMAL_DESTINATION\"]`,\n* `ENV[\"KAMAL_HOSTS\"`,\n* `ENV[\"KAMAL_PERFORMER\"]` - `gh config get -h github.com username` is preferred if set.\n* `ENV[\"KAMAL_RECORDED_AT\"]`,\n* `ENV[\"KAMAL_ROLE\"]`,\n* `ENV[\"KAMAL_RUNTIME\"]`,\n* `ENV[\"KAMAL_SERVICE_VERSION\"]`,\n* `ENV[\"KAMAL_SUBCOMMAND\"]`,\n* `ENV[\"KAMAL_VERSION\"]`,\n* `ENV[\"SHIPYRD_API_KEY\"]`,\n* `ENV[\"SHIPYRD_HOST\"]`,\n* Commit message - The first 90 characters of your commit message `git show -s --format=%s`.\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug 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).\n\n## Releasing a new version\n\nThe `bin/release` command will bump the version in the version.rb file, tag it, and push it up to github \u0026 rubygems.\n\n```\nbin/release 0.2.11\n```\n\n## Code of Conduct\n\nEveryone 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).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshipyrd%2Fshipyrd-gem","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshipyrd%2Fshipyrd-gem","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshipyrd%2Fshipyrd-gem/lists"}