Alternative Architecture DOJO

オルターブースのクラウドネイティブ特化型ブログです。

【GitHub Copilot】5分で始める!GitHub EnterpriseでGitHub Copilotを使ってみよう

(株)オルターブース、エンジニアの馬場です!
先日、弊社CTAMLBお兄さんこと松村さんによるこんな記事が出ました↓

aadojo.alterbooth.com

Visual StudioでもGitHub Copilotを使えるようになったとのこと。非常に便利ですね。
今回はGitHub Copilotネタ第二弾!GitHub Enterprise Cloudで使用できるGitHub Copilotの設定および使い方についてご紹介していきたいと思います。

GitHub Copilotを使うには

GitHub Copilotは「GitHub Copilotサブスクリプション」が有効になったアカウントでのみ使用することができます。
サブスクリプションには以下の二つがあります。

  • GitHub Copilot for Individuals
  • GitHub Copilot for Business

個人で使うか組織(ビジネス)で使うかということですね。
個人だと10$/月、組織だと一人あたり19$/月かかります。 ビジネスライセンスだと組織のコードをCopilot側にシェアしないような設定になっていたり、ポリシーを設定することができます。(※ポリシーについては後述)

docs.github.com

まずは組織で使用できるよう設定をしていきましょう!

GitHub Enterpriseの設定

GitHub EnterpriseでGitHub Copilotの設定を有効にするには、GitHub Enterpriseの管理者(Owner)が設定を行います。

  1. GitHub Copilotを有効にしたいOrganizationsの設定画面で、Copilotタブの「Access」へ移動する
  2. 「User Permissions」を選択する(無効、全員、特定のチーム/メンバーから選択)
  3. (特定のチーム/メンバーを選択した場合)チーム/メンバーを追加する

この時、チームを作成しそこに人を追加していく形にすると管理しやすくなるでしょう。
もし組織内でGitHubのチームを設定、管理している場合はチーム単位でライセンスを追加していく運用もよさそうです。

ポリシーを設定する

GitHub Enterpriseの設定画面に移動すると、GitHub Copilotのポリシーを設定できます。

2023年4月時点で設定できるポリシーは以下の二つです。

  1. Suggestions matching public code
    GitHubのパブリック コードと一致するコード候補を検出するポリシーです。有効になっていると、GitHub Copilot によってコード候補がパブリック コードと一致もしくは似ている場合は表示されません。
  2. Manage organization access to GitHub Copilot
    GitHub Enterprise内の他のOrganizationsでもGitHub Copilotを有効にするかどうか設定します。

docs.github.com

ここまでで設定は完了です。

VSCodeで始めるGitHub Copilot

あっという間に設定ができたので、次はVisual Studio CodeでGitHub Copilotを使えるようにしましょう。

操作手順は以下です。

  1. GitHub Copilotの拡張機能をインストールする
  2. 右下の「Sign in to GitHub」からGitHubへサインインする

ここで認証に成功したら使用できるようになっているはずです!
もし他のGitHubアカウントでCopilotを利用している場合は、一度サインアウトしてからサインインしなおす必要があります。

サンプルで動作確認

  1. 新しいJavascriptファイルを作成する
  2. 以下のコードを追加

     function calculateDaysBetweenDates(begin, end) {
    
  3. 候補がグレーアウトして出現するので、受け入れる場合はTabキーを押す

より詳しい操作方法についてはこちらをご覧ください。

docs.github.com

GitHub CopilotをOffにしたい

場合によってはCopilotをOffにしたいときがあると思います。

  1. VSCode下部のCopilotのアイコンをクリック
  2. 「グローバルに無効にする」もしくは「言語に対して無効にする」を選択

まとめ

こんな感じでさくっとGitHub Copilotの環境構築ができあがりました!簡単ですね。

GitHub Enterpriseでの管理方法について今後もまとめていきたいと思います。

www.alterbooth.com

www.alterbooth.com

www.alterbooth.com