GitHub
公式サイト:
使い方
参考:
ショートカットキー
操作
/
:検索バーに移動する
T
:ファイルを検索する
L
:指定した行番号に移動する
W
:ブランチあるいはタグを切り替える
Y
:コミット ID を指定したパーマリンクを取得する (アドレスバーの URL が変更される)
B
:ブレイムを開く
?
:ショートカットキーの簡易ヘルプを表示する
ドキュメント:
キーボードショートカット | GitHub Docs [公式]
Keyboard Shortcuts | GitHub Docs [Official]
ログイン/ユーザー認証
ドキュメント:
ソースコードにリンクを張る
特定の行範囲をハイライトする手順
- 最初の行番号を クリック する。
- 最後の行番号を
Shift
を押しながら クリック する。
参考:
GitHub で特定行へのパーマリンクを素早く表示する方法 – Qiita
GitHub 便利機能!特定の行をハイライト表示で共有する方法! | TickleCode
リリース
最新リリース
最新リリースページへのリンクは次の URL を用いる。
https://github.com/user_name/repo_name/releases/latest
ドキュメント:
参考:
GitHub の API を使って Release の最新バージョンを取得する – Qiita
Download artifacts from a latest GitHub release with bash and PowerShell | Mark Vincze
One Liner to Download the Latest Release from GitHub Repo (steinwaywhw) – GitHub Gist
Any way to download latest GitHub release with a batch script? – Stack Overflow
How to get the latest release version in GitHub only use Python requests? – Stack Overflow
コミットを比較する
フォーク先のブランチと比較する場合、次のような形式の URL にアクセスする。
https://github.com/user_name/repo_name/compare/branch_name...target_user_name:branch_name
ドキュメント:
プルリクエストを作成する
ドキュメント:
プルリクエストの作成方法 | GitHub Docs [公式]
フォークからプルリクエストを作成する | GitHub Docs [公式]
リポジトリをフォークする
ドキュメント:
リポジトリを複製する
ドキュメント:
リポジトリを削除する
ドキュメント:
参考:
SSH で接続する
手順
ssh-keygen
コマンドを使用して SSH キーを生成する。ssh-agent
に登録する。- GitHub に SSH キーを登録する。「Settings > SSH and GPG keys 」にアクセスして「New SSH key」ボタンを押して SSH キーの登録ページを開く。「Title」欄に SSH キーを識別する名称を入力し、「Key」欄に
id_rsa.pub
の内容を貼り付けて、「Add SSH Key」を実行する。 git@github.com:user_name/repo_name.git
からリポジトリをクローンする。- 既存のリモートの接続方法を変更する場合は、リモートリポジトリを
git@github.com:user_name/repo_name.git
の形式で設定する。
接続確認
ssh
コマンドで GitHub に接続する。
$ ssh -T git@github.com
認証に成功した旨のメッセージが表示されれば、SSH 接続は正常に設定されている。
Hi username! You've successfully authenticated, but GitHub does not provide shell access.
ドキュメント:
新しい SSH キーを生成して ssh-agent に追加する | GitHub Docs [公式]
SSH キーのパスフレーズを使う | GitHub Docs [公式]
GitHub アカウントへの新しい SSH キーの追加 | GitHub Docs [公式]
GitHub に SSH で接続する | GitHub Docs [公式]
SSH 接続をテストする | GitHub Docs [公式]
容量
- 1ファイル最大
100
MB まで - ブラウザ経由でアップロードできるのは、1ファイル最大
25
MB まで
リポジトリは小さく保ち、理想としては 1 GB 未満、および 5 GB 未満にすることを強くお勧めします。 リポジトリが小さいほど、クローン作成が速く、操作やメンテナンスが簡単になります。
50 MB より大きいファイルを追加または更新しようとすると、Git から警告が表示されます。
リポジトリ内の個々のファイルは、100 MB の最大サイズ制限に厳密に制限されています。GitHub は 100 MB 以上のプッシュをブロックします。
ブラウザ経由でリポジトリにファイルを追加する場合、そのファイルは 25 MB 以下でなければなりません。
—— GitHub Docs
ドキュメント:
大きいファイルについて | GitHub Docs [公式]
ストレージと帯域の利用について | GitHub Docs [公式]
大きなファイルを管理する | GitHub Docs [公式]
参考:
大きなファイルをコミットするとどうなるの? | ultra code
LFS
無料
- ストレージ:
1
GB - 帯域:
1
GB
データパック
- 料金: 1ヶ月当たり
5
ドル - ストレージ:
50
GB - 帯域:
50
GB
ドキュメント:
Git Large File Storage を設定する | GitHub Docs [公式]
Git Large File Storage でのコラボレーション | GitHub Docs [公式]
リポジトリのアーカイブで Git LFS オブジェクトを管理する | GitHub Docs [公式]
Git Large File Storage について | GitHub Docs [公式]
Git Large File Storage の使用状況の表示 | GitHub Docs [公式]
Git Large File Storage をアップグレードする | GitHub Docs [公式]
Git Large File Storage のダウングレード | GitHub Docs [公式]
Git Large File Storage の支払いを管理する | GitHub Docs [公式]
参考:
組織アカウント
ドキュメント:
Organization について | GitHub Docs [公式]
参考:
GitHub の Organization アカウントの運営について – Qiita
GitHub で会社用とプライベートアカウントを分けよう/問題ないよ | yoshi-taka
シングルサインオン (SSO)
参考:
全社的に会社用 GitHub アカウントを廃止した件 | ZOZO Technologies TECH BLOG
画像の埋め込み/リンク
参考:
Including Data from Github | Rodney Rehm
Is it possible to make relative link to image in a markdown file in a gist? – Stack Overflow
Github image without camo – Stack Overflow
画像の匿名化
ドキュメント:
About Anonymized URLs | GitHub Docs [Official]
リンク:
Proxying User Images | The GitHub Blog [Official]
Sidejack Prevention Phase 3: SSL Proxied Assets | The GitHub Blog [Official]
参考:
Github image without camo – Stack Overflow
バッジ
バッジ画像を更新する場合、画像を匿名化している URL をパージする。
参考:
Why is my coveralls.io badge not updating even when the builds are happening? – Stack Overflow
Build status badge not showing on GitHub – CircleCI Discuss
Azure pipeline badge image not found – GitHub Support Community
Github periodically can’t load and display codecov badge image – Codecov
Pull Request Decoration images are broken – SonarSource Community
特定のディレクトリ以下をダウンロードする
ツール:
リポジトリ:
参考:
Download a single folder or directory from a GitHub repo – Stack Overflow
GitHub Packages
ドキュメント:
GitHub Packages のドキュメント | GitHub Docs [公式]
Revert
参考:
Can I revert commits directly on GitHub? – Stack Overflow
日本語
リンク:
GitHub ヘルプドキュメントが日本語化されました | GitHub ブログ [公式]
参考:
GitHub は 日本語でのヘルプ完備/リポジトリ内での日本語使用や日本語でのサポートもあり | ポテパンスタイル
利用規定
ドキュメント:
GitHub 利用規定 | GitHub Docs [公式]
GitHub Acceptable Use Policies | GitHub Docs [公式]
運営
リンク:
GitHub の新たなフェーズへ! | GitHub ブログ [公式]
プッシュできない
現象:
公開鍵が拒否されてアクセスできない旨のエラーが発生する。
Permission denied (publickey)
対処法:
- 対象のリポジトリに認証用の SSH キーが登録されていることを確認する。
- SSH エージェントが起動し、認証鍵が登録されていることを確認する。
- 正しい鍵の組み合わせが使用されていることを確認する。
- SSH の設定を確認する。
参考:
Git エラー Permission denied (publickey) の解決方法 – Qiita
Permission denied (publickey) の 対処方法はだいたいこれ | ORM ねこの遊び庭
リンクに下線が表示される
対処法:
リンクの下線が不要な場合は、「Settings > Accessibility > Content > Link Underlines」の項目で Hide Link Underlines
を選択する。
リンク:
New Default: Underlined Links for Improved Accessibility | The GitHub Blog [Official]
ドキュメント:
Managing Accessibility Settings | GitHub Docs [Official]
ドキュメント
Documentation | GitHub [Official]
リンク
GitHub Japan (@GitHubJapan) | Twitter
GitHub VSCode Icons
入手: