はじめに
GitHubを利用しているとIssueを立ててPR(PullRequest)を作成するという流れがあるかと思います。
その際、PRのマージ後に手動でIssueを閉じるのが面倒くさいなと思ってる方々に向けての記事となります。
注意点
自動クローズ機能は、PRがdefault branch（通常はmainまたはmaster）にマージされた場合にのみ動作します。
前提
Issueが存在する
ローカルでブランチを作成してcommit済み
実践
1.GitHubにブランチをpushする
2.PRを作成する
3.PRの説明文にキーワードを追加
PRの説明文に以下の形式でキーワードを記載します
Closed #<Issue番号>
実際に書いてみます。
close以外にも以下のキーワードも使用出来ます。
- closes
- closed
- fix
- fixes
- fixed
- resolve
- resolves
- resolved
また、複数のIssueをCloseすることも出来ます。
Closes #1, #2, #3
Fixes #1
Fixes #2
Fixes #3
4.PR作成してマージする
5.対象のIssueを確認
PRがマージされた際に自動的にIssueも閉じてます。
まとめ
デフォルトブランチじゃなくリリース用ブランチ等にPRを出すプロジェクトだと使えないですが、個人開発などには使えるかと思います。