diff --git a/CLAUDE.md b/CLAUDE.md index 9729bd9..7959070 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -4,6 +4,8 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co ## Project Overview +> **Notice:** This repository is being archived in favour of [network-agent](https://github.com/deployhq/network-agent), which has fewer dependencies and is easier to install. Both are functional during the transition period. + Deploy Agent is a Ruby gem that creates a secure proxy allowing DeployHQ to forward connections to protected servers. It establishes a TLS connection to DeployHQ's servers and proxies connections to allowed destinations based on an IP/network allowlist. ## Development Commands diff --git a/README.md b/README.md index 177aacd..9a343dd 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # Deploy Agent +> **DEPRECATED:** This gem is deprecated and will not receive further updates. +> Please migrate to the new [network-agent](https://github.com/deployhq/network-agent) instead, +> which has fewer dependencies and is easier to install. +> +> Both agents remain functional during the transition period. + A secure proxy that allows [DeployHQ](https://www.deployhq.com/) to forward connections to servers behind firewalls. The agent establishes an outbound TLS connection to DeployHQ's servers and proxies deployment traffic to allowed destinations based on an IP/network allowlist. ## How It Works diff --git a/deploy-agent.gemspec b/deploy-agent.gemspec index d6f80bd..e87e452 100644 --- a/deploy-agent.gemspec +++ b/deploy-agent.gemspec @@ -7,7 +7,8 @@ Gem::Specification.new do |s| s.version = DeployAgent::VERSION s.required_ruby_version = '>= 2.7' s.summary = 'The DeployHQ Agent' - s.description = 'This gem allows you to configure a secure proxy through which DeployHQ can forward connections' + s.description = 'Deprecated: use https://github.com/deployhq/network-agent instead. ' \ + 'This gem allows you to configure a secure proxy through which DeployHQ can forward connections' s.authors = ['Charlie Smurthwaite'] s.email = ['support@deployhq.com'] s.files = Dir.glob('{lib,bin}/**/*') @@ -20,4 +21,9 @@ Gem::Specification.new do |s| s.add_dependency 'nio4r', '~> 2.7' s.add_dependency 'rb-readline', '~> 0.5' s.add_dependency 'timers', '~> 4.3' + + s.post_install_message = <<~MSG + WARNING: deploy-agent is deprecated and will not receive further updates. + Please migrate to the new agent: https://github.com/deployhq/network-agent + MSG end diff --git a/lib/deploy_agent/cli.rb b/lib/deploy_agent/cli.rb index 23f7eaf..36e7f92 100644 --- a/lib/deploy_agent/cli.rb +++ b/lib/deploy_agent/cli.rb @@ -4,7 +4,20 @@ module DeployAgent class CLI + DEPRECATION_NOTICE = <<~MSG + \e[33m╔══════════════════════════════════════════════════════════════════╗ + ║ DEPRECATED: deploy-agent will not receive further updates. ║ + ║ Please migrate to the new agent: ║ + ║ ║ + ║ https://github.com/deployhq/network-agent ║ + ║ ║ + ║ Fewer dependencies, easier to install. ║ + ╚══════════════════════════════════════════════════════════════════╝\e[0m + MSG + def dispatch(arguments) + warn DEPRECATION_NOTICE + methods = self.public_methods(false).delete_if { |n| n == :dispatch }.sort @options = {}