こんにちは、CX事業本部 Delivery部の若槻です。
このたびの GitHib のアップデートで、リポジトリ新規作成時にフォームのフィールドを自動入力できるようになりました。
この機能では、リポジトリ新規作成時に次のフィールドを予め指定することができます。
- name
- description
- visibility
- owner
- template_name
- template_owner
これにより、リポジトリのスムーズな作成や適切な情報の定義を行うことができるようになります。
試してみた
テンプレートリポジトリの用意
フィールドを自動入力を利用する上での必要条件ではありませんが、動作確認のため予めテンプレートリポジトリを用意しておきます。
今回は、以下のリポジトリをテンプレートリポジトリとします。
[Settings > General > Template repository] をチェックして、テンプレートリポジトリに設定します。
これにより、リポジトリ作成時にテンプレートリポジトリとして設定可能になりました。
フィールドを予め指定してリポジトリ作成
次の情報を予め指定してリポジトリを作成してみます。
- name：
test2 - description：
これはテスト用リポジトリです。 - visibility：
private - owner：
cm-rwakatsuki - template_name：
cm-rwakatsuki - template_owner：
test
情報の指定は、新規作成ページのURL `https://github.com/new` にクエリパラメータで行います。
https://github.com/new?owner=cm-rwakatsuki&name=test2&description=%E3%81%93%E3%82%8C%E3%81%AF%E3%83%86%E3%82%B9%E3%83%88%E7%94%A8%E3%83%AA%E3%83%9D%E3%82%B8%E3%83%88%E3%83%AA%E3%81%A7%E3%81%99%E3%80%82&visibility=private&template_owner=cm-rwakatsuki&template_name=test
URLを開くと、指定した情報が予め入力された状態で新規作成ページが表示されます。
リポジトリを作成できました。
使用できない値が指定されたフィールドは自動入力されません。
例えば権限の無い Owner を指定すると、Owner が指定されず警告が出ました。
おわりに
GitHib のアップデートで、リポジトリ新規作成時にフォームのフィールドを自動入力できるようになったのでご紹介しました。
この機能が役立つ場面としては、リポジトリの作成権限を持っているユーザーにリポジトリの新規作成を依頼する際に、所定の URL を共有するだけで適切な情報でのリポジトリ作成をスムーズに行ってもらえることができるというユースケースなどでしょうか。リポジトリの Owner 権限を開発者が持っていないことはよくありますからね。
以上
5
