chore: deprecate CLI in favor of deployhq-cli#24
Merged
Conversation
The CLI bundled in this gem is now deprecated. Users are directed to https://github.com/deployhq/deployhq-cli which offers more features, fewer dependencies, and first-class support for AI-assisted workflows. Deprecation notices added at three touchpoints: - README.md: prominent notice at the top - gemspec: post_install_message on gem install - CLI: stderr warning on every invocation The Ruby API library remains available for programmatic use. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughAdds deprecation notices for the bundled CLI: README updated, gemspec metadata and post-install message added, and runtime CLI now warns on invocation; a small initialization refactor in deployment progress output was made. The Ruby API library remains supported. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
lib/deploy/cli.rb (1)
36-38: Add an automated CLI spec for the new stderr warning.This PR changes user-visible CLI behavior, but there’s no CLI spec coverage yet. A focused spec around
.invoke+--helpwould lock this in and prevent regressions.🧪 Example spec skeleton
# spec/deploy/cli_spec.rb RSpec.describe Deploy::CLI do describe '.invoke' do it 'prints a deprecation warning to stderr' do expect do begin described_class.invoke(%w[--help]) rescue SystemExit # expected from --help path end end.to output(/DEPRECATED/).to_stderr end end end🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@lib/deploy/cli.rb` around lines 36 - 38, Add a focused RSpec that invokes Deploy::CLI.invoke with the --help argument and asserts the deprecation notice is written to stderr: call described_class.invoke(%w[--help]) inside an expect { ... }.to output(/DEPRECATED/).to_stderr, rescuing SystemExit from the help path; place this spec alongside other CLI specs and target Deploy::CLI.invoke so future changes to DEPRECATION_NOTICE or invoke's stderr behavior will be caught.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@deployhq.gemspec`:
- Line 12: The s.description assignment in deployhq.gemspec is too long and
breaks RuboCop's Layout/LineLength; update the s.description value (the
s.description = '...') to split the long text into multiple shorter string
segments (e.g., string literal concatenation, %q(...) or heredoc) so the
combined description remains the same but no single line exceeds the max length;
ensure the CLI deprecation note and the URL remain in the resulting string.
In `@README.md`:
- Around line 3-8: The README currently has a deprecation notice but later
sections ("CLI client" and "Development") still present the bundled CLI as
active; update those sections to reflect the deprecation and provide a single
migration path to the new DeployHQ CLI and guidance for contributors: modify the
"CLI client" section to clearly state the bundled CLI is deprecated, add a short
migration subsection that links to the DeployHQ CLI repo and lists equivalent
commands/workflows, and update the "Development" section to describe contributor
guidance (e.g., maintainers only, where CLI bugfixes should be accepted or
archived) or point PRs and feature work toward the new CLI instead of
instructing users to build/run the deprecated CLI.
---
Nitpick comments:
In `@lib/deploy/cli.rb`:
- Around line 36-38: Add a focused RSpec that invokes Deploy::CLI.invoke with
the --help argument and asserts the deprecation notice is written to stderr:
call described_class.invoke(%w[--help]) inside an expect { ... }.to
output(/DEPRECATED/).to_stderr, rescuing SystemExit from the help path; place
this spec alongside other CLI specs and target Deploy::CLI.invoke so future
changes to DEPRECATION_NOTICE or invoke's stderr behavior will be caught.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: e2df2491-a60f-4072-875f-d3ad6809e17c
📒 Files selected for processing (3)
README.mddeployhq.gemspeclib/deploy/cli.rb
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Fixes Style/ReduceToHash offenses in deployment_progress_output.rb. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
deployhq.gemspec (1)
11-11: Consider leading with the deprecation notice in the summary.The current format appends "(CLI deprecated)" at the end, which is functional but slightly buries the important deprecation information. Leading with it or restructuring might improve clarity, e.g.,
"DeployHQ API and CLI client (CLI deprecated)"→"API and CLI client for DeployHQ (CLI deprecated)"or"DeployHQ client library (CLI deprecated, API active)".🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@deployhq.gemspec` at line 11, Update the gemspec summary string assigned to s.summary to lead with or more clearly surface the deprecation notice; locate the s.summary assignment and replace the existing value "'API and CLI client for the DeployHQ (CLI deprecated)'" with a rephrased summary such as "'DeployHQ client library (CLI deprecated, API active)'" or "'API and CLI client for DeployHQ (CLI deprecated)'" so the deprecation appears at the start or is otherwise more prominent.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@deployhq.gemspec`:
- Around line 12-14: The s.description assignment has misaligned continuation
lines; adjust the continuation so each wrapped string literal aligns with the
opening single quote of the first line in the s.description assignment (i.e.,
align the second and third quoted lines with the opening quote used for
s.description), preserving the string concatenation backslashes and spacing;
locate the s.description assignment to apply the alignment fix.
---
Nitpick comments:
In `@deployhq.gemspec`:
- Line 11: Update the gemspec summary string assigned to s.summary to lead with
or more clearly surface the deprecation notice; locate the s.summary assignment
and replace the existing value "'API and CLI client for the DeployHQ (CLI
deprecated)'" with a rephrased summary such as "'DeployHQ client library (CLI
deprecated, API active)'" or "'API and CLI client for DeployHQ (CLI
deprecated)'" so the deprecation appears at the start or is otherwise more
prominent.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
🧹 Nitpick comments (1)
deployhq.gemspec (1)
27-30: Consider aligning install-time wording with README/runtime notice.At Line 28-Line 29, this message is clear, but it omits “will be removed in a future release,” which appears in
README.md:1-8andlib/deploy/cli.rb:25-34. Using the same phrasing across all three touchpoints would reduce ambiguity.Suggested wording alignment
s.post_install_message = <<~MSG - WARNING: The DeployHQ CLI bundled in this gem is deprecated. - Please migrate to the new CLI: https://github.com/deployhq/deployhq-cli + WARNING: The DeployHQ CLI bundled in this gem is deprecated and will be removed in a future release. + Please migrate to the new CLI: https://github.com/deployhq/deployhq-cli MSG🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@deployhq.gemspec` around lines 27 - 30, Update the s.post_install_message text in deployhq.gemspec (the s.post_install_message block) to match the README.md and lib/deploy/cli.rb wording by adding the phrase “will be removed in a future release” (or the exact shared phrasing used in those files) to the deprecation notice about the bundled CLI so all three notices are consistent.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@deployhq.gemspec`:
- Around line 27-30: Update the s.post_install_message text in deployhq.gemspec
(the s.post_install_message block) to match the README.md and lib/deploy/cli.rb
wording by adding the phrase “will be removed in a future release” (or the exact
shared phrasing used in those files) to the deprecation notice about the bundled
CLI so all three notices are consistent.
Replaces the active CLI usage examples and "experimental" development section with deprecation pointers to deployhq-cli, as flagged by CodeRabbit review. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
thdurante
approved these changes
Apr 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
post_install_message(install time), and stderr warning (every CLI invocation)Deploy::Resource, etc.) remains available for programmatic useTest plan
ruby -Ilib bin/deployhq --helpand verify the yellow deprecation banner appears on stderr before the help outputgem build deployhq.gemspecsucceeds andgem install ./deployhq-*.gemshows the post-install warning🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation
Chores
Refactor