fatal: could not read Username for github.com: 修正方法
最終更新:
fatal: could not read Username for 'https://github.com'は、gitがHTTPSで何かを取得しようとした際に認証情報を求められ、それを提供できなかったことを意味します。ワークフローには入力できるターミナルがないため、gitは処理を中断します。主な原因は、プライベートサブモジュール、git URLからインストールしたプライベートパッケージ、チェックアウトする別のリポジトリなど、プライベートリポジトリです。組み込みのGITHUB_TOKENは、ワークフローが実行されているリポジトリにしか使えません。
表示される正確なメッセージ
fatal: could not read Username for 'https://github.com': No such device or address
fatal: could not read Username for 'https://github.com': terminal prompts disabled
どちらの形式も同じ意味です。SSHリモートで関連するメッセージはPermission denied (publickey)です。
修正1:トークンを使って別のプライベートリポジトリをチェックアウトする
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v4
with:
repository: my-org/private-lib
path: private-lib
token: ${{ secrets.CROSS_REPO_TOKEN }}
CROSS_REPO_TOKENには、そのリポジトリのContentsに読み取りアクセスできるfine-grained個人用アクセストークンまたはGitHub Appのインストールトークンを使用してください。必要なリポジトリだけに限定したトークンを作成することをお勧めします。
修正2:プライベートサブモジュール
- uses: actions/checkout@v4
with:
submodules: recursive
token: ${{ secrets.CROSS_REPO_TOKEN }}
渡したトークンは、サブモジュールの取得にも使用されます。.gitmodulesファイルでSSH URLを使用している場合は、HTTPSに切り替えるか、SSHキーを使用してください(publickeyのページを参照)。
修正3:git URLからインストールされる依存関係
npm install、pip install git+https://...、go get、Cargoのgit依存関係はいずれも内部でgitを実行します。インストールステップの前に、すべてのGitHub HTTPS URLでトークンを使うようgitに指定してください:
- name: Let git use a token for private GitHub dependencies
run: git config --global url."https://x-access-token:${GH_TOKEN}@github.com/".insteadOf "https://github.com/"
env:
GH_TOKEN: ${{ secrets.CROSS_REPO_TOKEN }}
- run: npm ci
Goの場合は、Goプロキシにプライベートモジュールを問い合わせないよう、GOPRIVATE=github.com/my-org/*も設定してください。ホステッドランナーは毎回新しいマシンなので、ジョブの終了後にこの設定は残りません。再利用されるセルフホステッドランナーでは、トークンがディスクに残らないよう、git config --localを使うか、後で設定を解除してください。
修正4:トークンは設定されているが、アクセス権がない
すでにトークンを渡している場合は、有効期限が切れていないか、正しい組織向けに作成されているか、組織がSSOを要求している場合は組織のSSOが許可されているかを確認してください。適切なスコープがあっても特定のリポジトリへのアクセス権がないトークンでは、同系統のエラーが発生します。場合によってはRepository not foundと表示されることもあります。
修正5:リポジトリ名が間違っている
repository:のタイプミスは、認証の問題のように見える失敗を引き起こします。GitHubは、プライベートリポジトリが存在するかどうかを明らかにしないためです。
予防方法
- ワークフローが必要とするリポジトリのみに限定したGitHub Appトークンまたはfine-grainedトークンを使用してください。
- リポジトリをまたぐアクセスは、文書化された1つのシークレットにまとめ、有効期限のリマインダーを設定してください。
- デプロイキーを設定している場合を除き、CIではSSHよりもHTTPSとトークンの組み合わせを優先してください。
- パッケージレジストリで足りる場合は、プライベートなgit依存関係を避けてください。
- トークンを出力しないでください。シークレットはログでマスクされますが、デバッグ行でトークンを含むURLを作成すると、別の形で漏えいする可能性があります。
よくある質問
GITHUB_TOKENが別のリポジトリで機能しないのはなぜですか?
GITHUB_TOKENは、ワークフローを実行しているリポジトリに限定されています。他のプライベートリポジトリにアクセスするには、別のトークンが必要です。
このエラーはトークンが間違っていることを意味しますか?
このエラーは、そのURLに認証情報が提供されていないことを意味します。間違ったトークンを使用していた場合は、通常403やAuthentication failedが表示されます。
個人用アクセストークンは必要ですか?
必ずしも必要ではありません。特定の個人のアカウントに紐づかないため、チームにはGitHub Appのインストールトークンの方が適しています。
パブリックリポジトリでも発生しますか?
パブリックリポジトリをクローンする場合は発生しません。ただし、URLが名前を変更された、プライベートに変更された、または削除されたリポジトリを指している場合には表示されることがあります。
関連記事
- Cache Service Responded With 429: 修正方法GitHub Actions の「Failed to restore: Cache service responded with 429」を修正します。キャッシュへのリクエストが多すぎる場合の対処法です。actions/cache を更新し、復元は何度行っても構いませんが、保存は一度だけにしてください。
- Invalid Workflow File: YAML構文エラーの修正方法GitHub Actionsで"Invalid workflow file"と"You have an error in your yaml syntax"を解決する方法:インデント、予期しない値、不正な式をactionlintで確認します。
- GitHub ActionsでのJavaScript Heap Out of Memoryの修正方法GitHub ActionsでNODE_OPTIONSを使い、"FATAL ERROR: Reached heap limit Allocation failed - JavaScript heap out of memory"とnpm ENOMEMを解決する方法。
- GitHub ActionsでのPermission Denied (publickey)の修正方法GitHub Actionsで"git@github.com: Permission denied (publickey)"を解決する方法:SSHキーまたはデプロイキーを追加するか、プライベートリポジトリ向けにHTTPSトークンへ切り替えます。