GitHub を連携

このガイドでは、GitHub アカウントを Atoms に連携すること、リポジトリを作成すること、連携が機能していることを確認すること、そしてプロジェクトの Atoms 版と GitHub 版を同期した状態に保つことを含む、完全なセットアップ手順を説明します。

連携の仕組み

GitHub の連携には 2 つの段階があります。

1. GitHub アカウントを連携します。 これにより、Atoms はあなたに代わって GitHub を操作する権限を得ます。
2. プロジェクト用のリポジトリを作成します。 リポジトリとは、プロジェクトのコードと変更履歴が保存される GitHub 内のプライベートな場所です。

現在、Atoms は連携されたユーザー個人の GitHub アカウント内に 新しいプライベートリポジトリ を作成します。既存のリポジトリに連携したり、組織配下にリポジトリを作成したり、コネクタ経由で公開設定にしたりすることはできません。

開始前に

プロジェクトを GitHub に連携する前に、次の点を確認してください。

• ご利用の Atoms プランに GitHub connection が含まれていること。Free プランをご利用の場合、GitHub を選択すると Plans ページに移動します。
• GitHub を連携または切断できるのは workspace owner のみです。あなたがエディターの場合は、workspace owner にこの手順を実行してもらってください。
• GitHub アカウントを持っているか、セットアップ中に作成する準備ができていること。
• 使用しているブラウザで Atoms からのポップアップウィンドウが許可されていること。
• 現在、あなたのプロジェクトで エージェント が作業していないこと。

アカウントを連携するために GitHub の personal access token は必要ありません。GitHub のトークン、パスワード、その他の認証情報を Chat に貼り付けないでください。

GitHub アカウントを連携する

GitHub コネクタを開く

1. 連携したいプロジェクトを開きます。
2. チャットパネル右上にあるプロジェクト名をクリックします。
3. 表示されるドロップダウンメニューで Connectors を選択します。
4. 利用可能なコネクタの一覧で Github を見つけ、connect をクリックします。

Settings → Connectors → GitHub を開いて Connect を選択することもできます。

Settings → Connectors を開き、GitHub の Connect を選択します。

GitHub で Atoms を認可する

Connected Account に、使用したい GitHub アカウントがすでに表示されている場合、そのアカウントはすでに認可されています。そのまま Create a private repository に進めます。

1. Atoms によって GitHub の認可ウィンドウが開きます。連携したい GitHub アカウントでサインインするか、必要に応じて新しいアカウントを作成します。
2. 正しい GitHub アカウントでサインインしていることを確認します。
3. Atoms が要求する権限を確認します。同意する場合は Authorize Atoms-Agents を選択します。
4. Atoms に戻り、Connect success メッセージが表示されるまで待ちます。
5. Atoms で Connectors を開き、GitHub アカウントが連携済みとして表示されることを確認します。

Atoms は repo、read:user、workflow の OAuth 権限を要求します。これにより、Atoms は連携されたアカウントがアクセスできる公開および非公開リポジトリの読み書き、基本的なプロフィール情報の読み取り、そして GitHub Actions ワークフローファイルの追加または更新を行えるようになります。

この認可は連携された GitHub アカウントに適用され、現在の Atoms プロジェクト用に作成されたリポジトリのみに限定されるものではありません。Atoms は、連携されたアカウント自体がアクセスできないリポジトリにはアクセスできず、組織のポリシーによって追加の制限が課される場合があります。

GitHub の権限を確認し、Authorize Atoms-Agents を選択します。

プライベートリポジトリを作成する

GitHub アカウントを認可したら、プロジェクトのコードを保存するプライベートリポジトリを作成します。

1. Connected Account の下で、表示されているユーザー名が使用したい GitHub アカウントと一致していることを確認します。
2. Create New Repository の下で、リポジトリ名を入力します。名前は次の条件を満たす必要があります。
   • 1～100 文字であること。
   • 使用できるのは英字、数字、ハイフン (-)、アンダースコア (_)、ピリオド (.) のみ。
3. Create を選択します。
4. GitHub repository connected successfully! メッセージが表示されるまで待ちます。

Atoms は、連携されたユーザー個人の GitHub アカウント内に新しい プライベートリポジトリ を作成し、それを現在の Atoms プロジェクトにリンクしたうえで、プロジェクトの現在のファイルを GitHub にアップロードしようとします。

名前を入力して、新しいプライベートリポジトリを作成します。

連携が機能したことを確認する

リポジトリを利用する前に、Atoms と GitHub の両方で連携を確認してください。

1. Atoms で、Repository Status が Connected と表示されていることを確認します。
2. Branches の下で、1 つのブランチにチェックマークが付いていることを確認します。これが現在 Atoms プロジェクトに連携されているブランチです。GitHub を使い始めたばかりの場合は、このブランチを選択したままにしてください。
3. View on GitHub を選択します。
4. GitHub で、リポジトリが次の条件を満たしていることを確認します。
   • 正しい GitHub アカウントに属していること。
   • Private と表示されていること。
   • 期待どおりのプロジェクトファイルが含まれていること。
   • 少なくとも 1 つの commit があること。

リポジトリが空で、Atoms で Push Changes が利用可能な場合は、それを選択して処理が完了するまで待ちます。その後 GitHub のリポジトリページを更新し、プロジェクトファイルが表示されることを確認します。

Atoms で連携されたリポジトリと選択中のブランチを確認します。

GitHub でプライベートリポジトリとプロジェクトファイルを確認します。

Atoms と GitHub を同期した状態に保つ

Atoms と GitHub は自動では同期されません。どちらか一方で変更が行われた場合は、同期コントロールを使ってその変更をもう一方に反映してください。

Action	Use it when	What happens
Push Changes	Atoms で変更を行い、それを GitHub に送信したいとき。	Atoms は現在のプロジェクトファイルを選択中の GitHub ブランチに送信します。
Pull Updates	GitHub の選択中ブランチで変更が行われ、それを Atoms に取り込みたいとき。	Atoms は GitHub の最新の変更でプロジェクトを更新します。

変更を push または pull する前に、エージェント の作業が完了するのを待ち、Chat でプロジェクトの最新バージョンを表示していることを確認してください。History から古いバージョンを開いている場合は、Chat の下部にある最新バージョンのカードに戻ってから、GitHub を開き直してください。

最新バージョンを表示していない場合、Atoms は You must be on the latest version to pull updates or push changes. と表示します。

同期する前に、選択中のブランチが更新したいブランチであることも確認してください。

Atoms と GitHub の両方に保持したい変更がある場合は、まだ同期しないでください。まず重要な作業のコピーを保存するか、GitHub に詳しい人に依頼して別のブランチに変更を保持してもらってください。

Repository Status に Upstream Changes Available と表示されている場合、GitHub には Atoms がまだ持っていない変更があります。操作を選ぶ前にリポジトリを確認してください。

選択中のブランチに対して Pull Updates と Push Changes を使用します。

Atoms から GitHub に変更を push する

1. Atoms での変更作業を完了し、エージェント が停止するまで待ちます。
2. プロジェクトの最新バージョンを表示していることを確認します。
3. Settings → Connectors → GitHub を開き、正しいブランチが選択されていることを確認します。
4. Push Changes を選択します。
5. 変更が push されている間はページを開いたままにします。
6. Changes pushed successfully と表示されたら、View on GitHub を選択し、最新のプロジェクトファイルがあることを確認します。

Push Changes は、Atoms にまだ GitHub に送信されていない変更がある場合にのみ利用できます。エージェント が作業中のとき、またはプロジェクトの古いバージョンを表示しているときは利用できません。

Push Changes を選択すると、確認を求められることなく変更はすぐに GitHub に送信されます。 同じファイルが Atoms と GitHub の両方で変更されている場合は、Atoms 側のバージョンが優先され、現在 GitHub に保存されているバージョンを上書きします。

GitHub から Atoms に更新を pull する

push とは異なり、変更を pull するには最初に確認が必要です。同じファイルが GitHub と Atoms の両方で変更されている場合は、GitHub 側のバージョンが優先され、Atoms の現在のバージョンを上書きします。

1. Settings → Connectors → GitHub を開きます。
2. Repository Status に GitHub からの新しい変更が表示されており、正しいブランチが選択されていることを確認します。
3. Pull Updates を選択します。
4. Pull May Affect Project の警告を読みます。GitHub の変更を現在の Atoms プロジェクトに取り込みたい場合は、Confirm を選択します。
5. 変更が pull されている間はページを開いたままにします。
6. Changes pulled successfully と表示されたら、App ビューアー を開き、変更の影響を受けたプロジェクトの部分をテストして、すべてが期待どおりに動作することを確認します。

Pull Updates は、選択中の GitHub ブランチにまだ Atoms に取り込まれていない変更がある場合にのみ利用できます。

GitHub の連携を解除する

接続されたアカウントに Atoms がアクセスする必要がなくなったら、GitHub の連携を解除します。GitHub のリポジトリとそのファイルは GitHub に残りますが、Atoms は変更の push や pull を行えなくなります。

GitHub の認可は接続されたアカウントに適用されます。アクセスを取り消すと、その GitHub アカウントを使用しているすべての Atoms プロジェクトの連携が解除されるため、続行する前に他のプロジェクトを確認してください。

1. Settings → Connectors → GitHub を開きます。
2. Disconnect を選択します。
3. Disconnect GitHub の確認画面で、もう一度 Disconnect を選択します。
4. GitHub で該当する認可ページが自動的に開くはずです。開かない場合は、GitHub で Settings → Applications → Authorized OAuth Apps に移動します。
5. Atoms を見つけ、その行の右側にある ... を選択してから、Revoke を選択します。Revoke all は選択しないでください。この操作を行うと、そのページに一覧表示されている認可済み OAuth アプリすべてのアクセスが削除されます。
6. Github から求められる確認手順があれば、それに従います。
7. Atoms に戻り、GitHub コネクタを再度開いて、アカウントがもう連携されていないことを確認します。

GitHub コネクタで Disconnect を選択します。

GitHub で Atoms の OAuth アプリケーションのみを取り消します。