こんにちは！誕生日もブログ書くMizutani(@sirycity)です。エンジニアの鑑？

今日はGitHubの細かい仕様についてです。

結論

GitHubのAboutは何かpushしてからじゃないと書けない。…けどCLI経由ならいける。

gh repo edit 【ユーザー名】/【リポジトリ名】 -d 【説明】

Aboutについて

GitHubのリポジトリにはそのリポジトリの説明を書ける欄があります。DescriptionとWebsiteとTopics。

Descriptionはリポジトリの説明文、Websiteはリポジトリに関連するURL、Topicsは…タグみたいなやつです。これらを適切に設定することでリポジトリが見やすくなります。余談ですが、GitHubはリポジトリを整理する機能が貧弱でグループ分け機能とかが無いです。GitLabにもBitbucketにもあるのにね。

Aboutはいきなりは書けない

ただしこのAbout、リポジトリを作ってすぐに書くことはできません。なんか内容的にもいつでも書けそうなもんですが、Aboutはコードを何かpushしてからじゃないと書けないです。

困る点

じゃあこの仕様がめっちゃ困るかというとそんな事はなく、別に何か書きたかったら適当にREADMEとかをpushすればいいわけです。ただ、何となくですが新しいリポジトリ作る時に説明とかは最初から書いておきたくなることないですか？…そんなことない？

解決方法

といっても仕様的にpushしてからじゃ書けないのでしょうがないです。…と思いきや裏技があってCLI経由ならpush前にAboutが編集できます。

GitHubのCLIは色々ありますが今回は公式のGitHub CLIを使います。hubとかでもいけると思う(未検証)

GitHub CLIはghって名前で落とせます。Homebrew経由ならこう。

brew install gh

んで初回はログインします。ブラウザ経由のログインになります。

gh auth login

そしたらもういきなり設定できます。こんな感じに。

gh repo edit 【ユーザー名】/【リポジトリ名】 -d 【説明】

たとえばlinuxのリポジトリに設定するとしたらこう。

gh repo edit torvalds/linux -d これはLinuxのリポジトリです

さいごに

まあAboutの設定にCLIに抜け道があるってそんだけの記事です。というかGitHub CLIはとにかく便利なのでむしろこっちの記事を書きたいと、そう思った誕生日の夜でした。28歳になったMizutaniより。おしまい。