クエリパラメータ付きのIssule及びプルリクエストの自動化について
クエリパラメータを使って、カスタマイズされた情報を持つURLを共有できます。
クエリパラメータはカスタマイズ可能なURLのオプション部分で、GitHub上の検索フィルタの結果やIssueテンプレートといった特定のWebページビューを共有できます。 独自のクエリパラメータを作成するには、キーと値のペアをマッチさせなければなりません。
クエリパラメータを使うには、同等のアクションを行うための適切な権限を持っていなければなりません。 たとえばクエリパラメータのlabelsを使うには、Issueにラベルを追加する権限を持っていなければなりません。
クエリパラメータを使うのに不正なURLを作成したり、適切な権限を持っていなかったりした場合には、そのURLに対して404エラーページが返されます。
サポートされているクエリパラメータ
| クエリパラメータ | サンプル |
|---|---|
body |
https://github.com/octo-org/octo-repo/compare/master...pull-request-test?quick_pull=1&body=Fixes+the+problem. は、master と pull-request-test のブランチを比較して、ボディに "Fixes the problem" というコメントを付けてプルリクエストを作成します。 |
title |
https://github.com/octo-org/octo-repo/issues/new?labels=bug&title=New+bug+report は、"bug" というラベルと "New bug report" というタイトルを付けて Issue を作成します。 |
labels |
https://github.com/octo-org/octo-repo/compare/master...pull-request-test?quick_pull=1&labels=bug は、master ブランチと pull-request-test ブランチを比較して、"bug" というラベルを付けてプルリクエストを作成します。 |
template |
https://github.com/octo-org/octo-repo/issues/new?template=issue_template.md は、ボディにテンプレートを付けて Issue を作成します。 |
マイルストーン |
https://github.com/octo-org/octo-repo/issues/new?milestone=testing+milestones は、"testing milestones" というマイルストーンを持たせて Issue を作成します。 |
assignees |
https://github.com/octo-org/octo-repo/issues/new?assignees=octocat は、Issue を作成して @octocat に割り当てます。 |
projects |
https://github.com/octo-org/octo-repo/issues/new?title=Bug+fix&projects=octo-org/1 は、"Bug fix" というタイトルを付けて Issue を作成し、それを Organization のプロジェクトボード 1 に追加します。 |
カスタムテンプレートでIssueやプルリクエストを記入する
これはIssueのテンプレートを作成するための古いワークフローです。アップグレードされた複数のIssueテンプレートビルダーを使って複数のIssueテンプレートを作成することをおすすめします。詳しい情報についてはIssue及びプルリクエストテンプレートを参照してください。
templateクエリパラメータを使い、テンプレートを指定して自動的にIssueやプルリクエストのボディに記入することができます。 templateクエリパラメータは、ISSUE_TEMPLATEあるいはルート内のPULL_REQUEST_TEMPLATE左武ディレクトリ、リポジトリ内のdocs/あるいは.github/ディレクトリに保存されたテンプレートで動作します。
リポジトリにデフォルトのプルリクエストあるいはIssueのテンプレートしかない場合、新しいIssueやプルリクエストはボディ中にデフォルトのテンプレートを持つことになります。
詳しい情報についてはリポジトリ中でのプルリクエストテンプレートの作成あるいはリポジトリ用の単一Issueテンプレートの手動での作成を参照してください。