GitHubについて 備忘録

各種アイコンについて

Pin

権限がある(自分の)リポジトリに対してpinを付けることが可能
Pinを付けるとReadMeの下にPinnedとして表示される

Unwatch

権限がない(他人の)リポジトリに対して更新状態を監視することができる。

Watchを選択すると以下が表示される

・Participating and @mentions(デフォルト)
このリポジトリ内で、自分がアサインされているissues等での反応や、@メンションをされた際に通知を送る

・All Activity
Customで設定できる全てをオンにした状態

・Ignore
決して通知を送らない

・Custom

• issues
• Pull requests
• Releases
• Discussions
• Security alerts
  それぞれのイベントが発生した時に通知を送る

Fork

他人のリポジトリを自分のアカウントのリモートリポジトリにコピーする。
この動作はオリジナルリポジトリへの貢献が前提で、リポジトリを所有する開発者に通知が送られる。
(ForkをすることでPullRequestを送ることができる)

Star

GoogleChromeのお気に入り機能のようなもの
プルダウンボタンから、リストを作成し整理ができる

リポジトリのアイコンについて

main

ブランチの切り替えや新規作成を行える

Go to file

ファイルの検索を行える

Code

ローカルリポジトリ(自分のPC)にクローン(コピー)できる

HTTPS

• ユーザー名・パスワードで認証
• SSHでのクローンより比較的高速
  GitHubの推奨している方式で、前からずっと使ってきた方式でもある。

SSH

• 公開鍵をGitHubに登録して認証する
• SSHを使うため安全性が高い
• 鍵の生成などHTTPSに比べて少し手間がかかる
  クローン速度ではHTTPSに劣ると言われるが、安全性が保たれているのは大きなメリットだと感じる。鍵の生成と登録が少し手間にはなるが、毎回ユーザー名、パスワードを入れなくても良くなるのは便利。

公式ドキュメント

GitHub CLI

GitHubが公式で提供するコマンドラインインターフェース　GitHub CLIを使用してリポジトリをクローンする。

試したことがないが、ターミナルから直接GitHubを操作できるのが便利そう。

クローンする際には、ユーザー認証をして使用するとのこと。
https://github.com/cli/cli

Open with GitHub Desktop

GitHubDesktopを開くことができる。
また、Sourcetreeで開くことも可能

Security

• Security policy
  セキュリティーの脆弱性が見つかった場合、発見者がすべき行動をSECURITY.mdに記載できる
  example

• Security advisories

• Dependabot alerts
  依存関係に脆弱性がある場合、通知を受けることができます。

• Code scanning alerts
  よくある脆弱性やコーディングミスを自動で検出

Insights

Pulse

Overviewでマージされたプルリクエストやマージ待ちプルリクエスト、イシューの数などが確認できる。

Contributors

開発メンバーのコミット数のグラフを確認できる。

Community

IssuesやPullRequest, Discussionsの利用状況を確認できる

Community Standards

IssuesのテンプレートやPullRequestのテンプレートなどを作成できる。

Traffic

Git clone数やVisitors、views数を確認できる。

Commits

コミット数のグラフ、曜日別などで確認できる。

Code frequency

Additions,Deletions具合を確認できる。

Dependency graph

リポジトリが依存しているライブラリなどを可視化するもの。

Network

gitのログが枝分かれなどが図式化されているので分かりやすい。

Forks

forkが無いと表示されるものがない。

People

このリポジトリに対して権限を持つメンバー

Settings

General

Repository name

リポジトリの名前を変更する

Template repository

このリポジトリをテンプレートとして使用するかどうか
詳しくはこの記事を

Social preview

SNS等でリポジトリのURLを貼った時に表示されるプレビューの画像を設定できる

Features

• Wikis
  リポジトリのドキュメントを作成するかどうか
  Restrict editing to users in teams with push access only
  はWikiの編集権をプッシュアクセス権があるユーザーにだけ制限をかけることができる。

• Issues
  Issuesを作成するかどうか

• Sponsorships
  財政的な支援を求めるかどうか

• Projects
  チケット制のプロジェクトボードを作成するかどうか

• Preserve this repository
  GitHubの全パブリックリポジトリを北極圏の地下に1000年間保存する「GitHub Arctic Code Vault」に参加するかどうか
  詳しくは
  要するに世界種子貯蔵庫みたいに、プログラムデータも保存しようぜという取り組み
  GitHubの全パブリックリポジトリが対象でデフォルトではチェック(参加)となっている

• Discussions
  Issuesを作成せずに会話や質問できる場を作成するかどうか

PullRequests

どれかに1つはチェックがないといけない

• Allow merge commits
• Allow squash merging
• Allow rebase merging
• Always suggest updating pull request branches
• Allow auto-merge
• Automatically delete head branches

Archives

• Include Git LFS objects in archives
  よくわからなかったが、GitHubのアーカイブにラージファイル(容量の大きいファイル)を含めるかどうか

GitHub Pages

静的サイトのホスティングサービス
つまり、ログイン系ではないWebサービスなら、これを使うと表示できますよと

Danger Zone

• Change repository visibility
  リポジトリをパブリックかプライベートかを変更する

• Transfer ownership
  リポジトリの所有権を譲渡
  利用例
  個人開発からチーム開発への移行に伴い、自分のリポジトリから組織リポジトリへ所有権を譲渡

• Archive this repository
  よくわからなかったが、このリポジトリは使用しなくなったが、削除すると記事のリンクに貼ってる場合は404になるけど、新しいPRs/issues/commentsは来なくしたいと言った時に使用するのかな？

• Delete this repository
  リポジトリの削除

Collaborators and teams

外部の人にリポジトリへのプッシュアクセス等の権利を与えたい場合

Team and member roles

組織アカウントでの役割を細かに設定できる

詳しくは

Moderation options

Interaction limits

Code review limits

Reported content

Branches

Default branch

デフォルトのブランチを設定できる

Branch protection rules

ブランチを保護することができる。
個人開発であれば、必要性はそこまで感じないが
複数人での開発を行う際に、mainブランチへのマージはコードレビューを受けたプルリクのみなど指定ができる

Tags

Protected tags

タグの命名を保護する

Actions

General

Runners

Webhooks

Environments

Pages