Capistranoでデプロイしたときにリモートリポジトリ(Github)への接続に失敗する場合の対処法

Capistranoを使ってRailアプリをデプロイするとき、直接サーバーに送るのではなく、Githubを経由してファイルが送信されます。
そのため、あらかじめサーバー上で秘密鍵と公開鍵の組み合わせを生成し、公開鍵をGithubに登録しておく必要があります。
そして接続情報は設定ファイル(/etc/ssh/ssh_config または ~/.ssh/config)に記述しておくのですが、接続情報をきちんと書かないとデプロイに失敗してしまいます。

事象

以下のコマンドでRailsアプリをデプロイしようとしました。
$ bundle exec cap production deploy --trace
すると以下のエラーが出力されました。
...
git stderr: Permission denied (publickey).
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.
...
リモートリポジトリ(Githubのこと)への接続に失敗しているようです。

調査

サーバーにSSH接続して設定ファイルを確認してみます。
$ cat ~/.ssh/config
Host github
  HostName github.com
  IdentityFile ~/.ssh/github/id_rsa
  User git
おかしそうなところは特にありません。
実際、テスト接続は成功します。
$ ssh -T github
Hi whitia! You've successfully authenticated, but GitHub does not provide shell access.
過去に別のサーバーに同じ手順でデプロイしたことがあるので、そちらの設定ファイルはどうなっているか確認してみます。
$ cat ~/.ssh/config
Host github github.com
  HostName github.com
  IdentityFile ~/.ssh/github/id_rsa
  User git
なんか差異がありますね…

結論

ホスト名は「github」ではなく「github.com」が正しいということでした。
その他、わかったことは…
  • Capistranoでデプロイしたいだけならホスト名の「github」は不要(「github.com」のみでよい)
  • 接続情報は /etc/ssh/ssh_config と ~/.ssh/config のどちらに書いてもよい

関連記事

【Rails】Paranoiaを使用した論理削除(ソフトデリート)
# はじめに Paranoiaは、Railsアプリケーションで論理削除(ソフトデリート)を実現するためのGemです。 論理削除は、データベースのレコードを物理的に削除するのではなく、削除フラグを設定することで「削除済み」とみなす方法です。こ [...]
2024年7月20日 21:33
【Rails】activerecord-multi-tenantを使用したマルチテナントアプリケーションの作成
# はじめに マルチテナントアプリケーションでは、複数の顧客(テナント)が同じアプリケーションを利用するため、データの分離が必要です。 activerecord-multi-tenantは、このようなマルチテナント環境をサポートするための便 [...]
2024年7月18日 16:50
【Rails】RubyとRailsにおけるattr_reader, attr_writer, attr_accessorの概念と使用方法
# はじめに RubyとRailsの開発において、`attr_reader`,`attr_writer`,`attr_accessor`は非常に便利なメソッドです。これらは、クラス内でインスタンス変数に対するゲッターおよびセッターメソッドを簡単に [...]
2024年7月17日 18:11
【Rails】RubyとRailsにおけるyieldの概念と使用方法
# はじめに RubyとRailsにおける`yield`は、メソッドやテンプレートの中で動的にコードブロックを実行する能力を提供し、これによってコードの再利用性と拡張性が大幅に向上します。本記事では、RubyとRailsにおける`yield`の概 [...]
2024年7月17日 13:15
【Rails】AASMを使用してオブジェクトの状態遷移を効率的に管理
# はじめに Railsアプリケーションにおいて、オブジェクトの状態管理は重要な課題の一つです。AASM (Acts As State Machine) gemは、複雑な状態遷移を効率的に管理します。本記事では、AASMの基本的な使い方を解説して [...]
2024年7月16日 18:00
【Rails】RSpec + Swagger + rswagでアプリケーションのAPIをテストおよびドキュメント化する方法
# はじめに Railsアプリケーションの開発において、APIのテストとドキュメント化は重要な要素です。 RSpecはテストフレームワークとして広く利用されており、SwaggerはAPIの設計とドキュメント化を支援します。これらを統合するr [...]
2024年7月16日 14:27
【Rails】mailcatcherを使用して開発環境でメール送信をテストする方法
# はじめに mailcatcherは、開発環境でのメール送信をキャプチャするためのツールです。ローカルで送信されたメールをブラウザ上で簡単に確認できるようにします。mailcatcherをRailsアプリケーションで使用する方法について説明しま [...]
2024年7月15日 16:37
【Rails】impressionistを使用してページビューやクリック数を追跡する方法
# はじめに impressionist Gemを使用してRailsアプリケーションでページビューやクリック数を追跡する方法について説明します。 # 実装方法 ## impressionist Gemのインストール まず、impre [...]
2024年7月15日 14:18