GitHub社によって運営されているソースコードの変更履歴を管理するホスティングサービス

GitHub

Amazon.comにより提供されているクラウドコンピューティングサービス

コンピュータプログラムで問題を解決するための手順や計算方法のこと

Algorithm

継続的インテグレーション＆継続的デリバリーの略で、アプリケーションの構築、テスト、および展開の自動化を指す

CI/CD

コンテナ仮想化を用いてアプリケーションを開発・配置・実行するためのDocker​社製オープンソースソフトウェア

Docker

静的なHTMLをベースに、JavaScriptを用いたAPIを通じて動的なコンテンツを扱うWebサービスのアーキテクチャ

Jamstack

Facebook社がOSSとして開発を進めているJavaScript用テスティングフレームワーク

Jest

MVCモデルでWebアプリケーションを開発できるオープンソースWebアプリケーションフレームワーク

Laravel

GoogleのMaterialデザインをベースに開発された、ウェブ開発をより高速かつ簡単にするReactコンポーネント

Material-UI

Oracle社が中心となって開発しているオープンソースのリレーショナルデータベース管理システム

MySQL

Vercel社がOSSとして開発を進めているReactベースのフロントエンドフレームワーク

Next.js

The PHP Groupによってコミュニティベースで開発されているオープンソースの汎用プログラミング言語。

Facebook社とコミュニティによって開発されているUI構築のためのJavaScriptライブラリ

React

マイクロソフトが開発・販売しているGUIを採用したオペレーティングシステムの製品群

Windows

GitHub - Breathnote

[GitHub CLI](https://github.com/cli/cli)は、ブラウザ上でのGitHub操作をコマンドラインで実行できるツールです。慣れるまで大変ですが、対話形式に対応していたりと便利なので、使いこなせるようになりたいものです。

※ [ver 1.10.3](https://github.com/cli/cli/releases/tag/v1.10.3)対応済み。

## コマンド一覧

各コマンドの詳細とオプションは、[公式マニュアル](https://cli.github.com/manual/)もしくは`gh`コマンドから確認できます。

### リポジトリの操作

`gh repo`から始まるコマンドです。リポジトリのリスト表示や詳細の確認、新規作成、クローン、フォークなどを行えます。

<div className="codeblock-filename">shell</div>

```bash
# リポジトリをクローン
$ gh repo clone <[repository]>

# リポジトリを新規作成
$ gh repo create <[repository]>

# リポジトリをフォーク
$ gh repo fork <[repository]> <[option]>

# リポジトリのリストを表示
$ gh repo list <[owner]> <[option]>

# リポジトリの詳細を表示
$ gh repo view <[repository]> <[option]>
```

### プルリクエストの操作

`gh pr`から始まるコマンドです。プルリクエスト関連を操作できます。

<div className="codeblock-filename">shell</div>

```bash
# 指定したPRのブランチへ切り替え
$ gh pr checkout <[number> | <url> | <branch]> <[option]>

# PRのCIステータスを表示
$ gh pr checks <[number> | <url> | <branch]> <[option]>

# PRを閉じる
$ gh pr close <[number> | <url> | <branch]> <[option]>

# PRにコメントを投稿
$ gh pr comment <[number> | <url> | <branch]> <[option]>

# PRを新規作成
$ gh pr create <[option]>

# PRの差分を確認
$ gh pr diff <[number> | <url> | <branch]> <[option]>

# PRを編集 (タイトル・概要・ラベル・担当者など)
$ gh pr edit <[number> | <url> | <branch]> <[option]>

# PRのリストを表示
$ gh pr list <[option]>

# PRをマージ
$ gh pr merge <[number> | <url> | <branch]> <[option]>

# PRをレビュー段階としてマーク
$ gh pr ready <[number> | <url> | <branch]> <[option]>

# 閉じたPRを再開
$ gh pr reopen <[number> | <url> | <branch]> <[option]>

# PRにレビューを追加 (コメント・承認・修正依頼)
$ gh pr reopen <[number> | <url> | <branch]> <[option]>

# 各PRのステータスを表示
$ gh pr status <[option]>

# PRの詳細を表示
$ gh pr view <[option]>
```

### イシューの操作

`gh issue`から始まるコマンドです。イシュー関連を操作できます。

<div className="codeblock-filename">shell</div>

```bash
# イシューを閉じる
$ gh issue close <[number> | <url]> <[option]>

# イシューにコメントを追加する
$ gh issue comment <[number> | <url]> <[option]>

# 新しいイシューを作成する
$ gh issue create <[option]>

# イシューを削除する
$ gh issue delete <[number> | <url]> <[option]>

# イシューを編集する
$ gh issue edit <[number> | <url]> <[option]>

# イシューの一覧を表示する
$ gh issue list <[option]>

# クローズしたイシューを再度開く
$ gh issue reopen <[number> | <url]> <[option]>

# イシューのステータスを表示する
$ gh issue status <[option]>

# イシューを別のリポジトリに移動する
$ gh issue transfer <[number> | <url]> <[destination-repo]> <[option]>

# イシューの詳細情報を表示する
$ gh issue view <[number> | <url]> <[option]>
```

## GitHub CLIのアップデート

GitHub CLI本体の更新方法もまとめておきます。

### Windows

<div className="codeblock-filename">shell</div>

```bash
# WinGet
$ winget install gh

# scoop
$ scoop update gh

# Chocolatey
$ choco upgrade gh
```

### macOS

<div className="codeblock-filename">shell</div>

```bash
# Homebrew
$ brew upgrade gh

# MacPorts
$ sudo port selfupdate && sudo port upgrade gh
```

### Linux

<div className="codeblock-filename">shell</div>

```bash
# Debian, Ubuntu Linux (apt)
$ sudo apt update
$ sudo apt install gh

# Fedora, CentOS, Red Hat Enterprise Linux (dnf)
$ sudo dnf update gh

# openSUSE/SUSE Linux (zypper)
$ sudo zypper ref
$ sudo zypper update gh
```

2020年にリリースされたGitHub CLI。個人的によく利用するコマンドをまとめています。ver 1.10.3 対応済み。

GitHub CLI コマンドリファレンス

最近（と言っても2か月前の話ですが）、`GITHUB_TOKEN`のパーミッションが変更され、Dependabotが作ったプルリクエストで`GITHUB_TOKEN`が読み込めなくなりました。

これの何が困るかというと、「自動テストの中に外部APIを叩くステップがあり、接続のためのトークンを`GITHUB_TOKEN`から読み込んでいる」といったテストが失敗するようになったのです。まあ、この例ではAPIのモックを作れば済む話ですが、今回はこれを何とかします。

- [Workflows triggered by Dependabot PRs will run with read-only permissions](https://github.blog/changelog/2021-02-19-github-actions-workflows-triggered-by-dependabot-prs-will-run-with-read-only-permissions/)
- [Dependabot が起動する GitHub Actions Workflow から write 権限が無くなった件](https://shogo82148.github.io/blog/2021/03/17/actions-check-permissions/)

## ※ 追記（2022年4月9日）

[こちらの記事（上記の参考記事②と同じ）](https://shogo82148.github.io/blog/2021/03/17/actions-check-permissions/)の追記にあるとおり、`GITHUB_TOKEN`のパーミッションを指定できるようになりました。Dependabotもこれに従うようですので、本記事の問題も回避できます。

## 対処法

パーミッションが変更されたのは、**Dependabotがトリガーをセットしたワークフロー**のみ。同じワークフローを自分でre-runすると、問題なく`GITHUB_TOKEN`を読み込めました。

> プルリクエストを作ったときに実行されるワークフローがread-only権限になる。<br/>
> 上記ワークフローをre-runするとwriteパーミッションがついて実行される。<br/>
> `@dependabot merge`でマージした場合、pushイベントでトリガーされたワークフローもread-onlyになる。<br/>
> re-runするとwriteパーミッションがつく。<br/>
> 意図したものなのかは不明。

最後の一文が怖いですが、現時点 (2021/05/11) ではこの対処法で乗り切っています。

GITHUB_TOKENのパーミッション変更により、Dependabotが作ったプルリクエストでGITHUB_TOKENが読み込めなくなりました。現状の対処法は「自分で再度re-runする」です。

GitHub

GitHub CLI コマンドリファレンス

Dependabotが作るプルリクで、GitHub ActionsのGITHUB_TOKENが読み込めない