连接 GitHub
将你的 Atoms 项目连接到 GitHub,以便将其代码保存在私有仓库中,并在不使用 Git 命令的情况下在 Atoms 和 GitHub 之间同步更改。
将你的 Atoms 项目连接到 GitHub,以便将其代码保存在私有仓库中,并在不使用 Git 命令的情况下在 Atoms 和 GitHub 之间同步更改。
本指南将说明完整的设置流程:将你的 GitHub 账户连接到 Atoms、创建仓库、确认连接正常工作,以及让项目在 Atoms 和 GitHub 中的版本保持同步。
连接如何工作
连接 GitHub 分为 2 个阶段:
- 连接你的 GitHub 账户。 这将授予 Atoms 代表你与 GitHub 交互的权限。
- 为你的项目创建一个仓库。 仓库是 GitHub 中用于存储项目代码和更改历史的私有空间。
Atoms 目前会在已连接用户的个人 GitHub 账户中创建一个新的私有仓库。你无法连接到现有仓库、无法在组织名下创建仓库,也无法通过该连接器将其设为公开。
开始之前
在将项目连接到 GitHub 之前,请确保:
- 你的 Atoms 套餐包含GitHub 连接。如果你使用的是免费套餐,选择 GitHub 会将你带到套餐页面。
- 只有工作区所有者才能连接或断开 GitHub。如果你是编辑者,请让工作区所有者执行此步骤。
- 你已有 GitHub 账户,或准备在设置过程中创建一个。
- 你的浏览器允许来自 Atoms 的弹出窗口。
- 当前没有智能体正在处理你的项目。
你无需 GitHub personal access token 即可连接账户。切勿将 GitHub Token、密码或其他凭据粘贴到 Chat 中。
连接你的 GitHub 账户
打开 GitHub 连接器
- 打开你想要连接的项目。
- 点击聊天面板右上角的项目名称。
- 在出现的下拉菜单中选择Connectors。
- 在可用连接器列表中找到Github,然后点击connect。
你也可以打开Settings → Connectors → GitHub并选择Connect。
打开 Settings → Connectors,并为 GitHub 选择 Connect。
在 GitHub 中授权 Atoms
如果Connected Account已经显示你想使用的 GitHub 账户,则说明该账户已完成授权。你可以继续执行创建私有仓库。
- Atoms 会打开一个 GitHub 授权窗口。登录你想连接的 GitHub 账户,或在需要时创建一个新账户。
- 检查你登录的是否是正确的 GitHub 账户。
- 查看 Atoms 请求的权限。如果你同意,请选择Authorize Atoms-Agents。
- 返回 Atoms,并等待出现Connect success消息。
- 在 Atoms 中,打开Connectors并确认你的 GitHub 账户显示为已连接。
Atoms 会请求 repo、read:user 和 workflow OAuth 权限。这些权限允许 Atoms 读取和写入已连接账户可访问的公开和私有仓库、读取基本个人资料信息,以及添加或更新GitHub Actions工作流文件。
此授权适用于已连接的 GitHub 账户,并不限于为当前 Atoms 项目创建的仓库。Atoms 无法访问该连接账户本身无权访问的仓库,且组织策略可能会施加额外限制。
查看 GitHub 权限并选择 Authorize Atoms-Agents。
创建私有仓库
在授权你的 GitHub 账户后,创建将用于存储项目代码的私有仓库。
- 在Connected Account下,检查显示的用户名是否与你想使用的 GitHub 账户一致。
- 在Create New Repository下,输入仓库名称。名称必须:
- 包含 1–100 个字符;
- 仅使用字母、数字、连字符 (
-)、下划线 (_) 或句点 (.)。
- 选择Create。
- 等待出现GitHub repository connected successfully!消息。
Atoms 会在已连接用户的个人 GitHub 账户中创建一个新的私有仓库,将其链接到当前 Atoms 项目,然后尝试将项目当前文件上传到 GitHub。
输入名称并创建新的私有仓库。
检查连接是否成功
在依赖该仓库之前,请同时在 Atoms 和 GitHub 中检查连接状态。
- 在 Atoms 中,确认Repository Status显示为Connected。
- 在Branches下,检查是否有一个分支带有勾选标记。这是当前连接到你的 Atoms 项目的分支。如果你刚开始使用 GitHub,请保持选中该分支。
- 选择View on GitHub。
- 在 GitHub 中,确认该仓库:
- 属于正确的 GitHub 账户;
- 被标记为Private;
- 包含预期的项目文件;并且
- 至少有一个commit。
如果仓库为空,且 Atoms 中可用Push Changes,请选择它并等待操作完成。然后刷新 GitHub 中的仓库页面,并检查项目文件是否已显示。
在 Atoms 中检查已连接的仓库和所选分支。
在 GitHub 中验证私有仓库和项目文件。
让 Atoms 和 GitHub 保持同步
Atoms 和 GitHub 不会自动保持同步。当任一侧发生更改时,请使用同步控件将这些更改同步到另一侧。
操作 | 使用时机 | 会发生什么 |
|---|---|---|
Push Changes | 你在 Atoms 中进行了更改,并希望将其发送到 GitHub。 | Atoms 会将当前项目文件发送到所选的 GitHub 分支。 |
Pull Updates | GitHub 中所选分支发生了更改,而你希望将这些更改带入 Atoms。 | Atoms 会使用 GitHub 中的最新更改更新项目。 |
在推送或拉取更改之前,请等待智能体完成工作,并确保你在 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
- 在 Atoms 中完成更改,并等待智能体停止工作。
- 确保你查看的是项目的最新版本。
- 打开Settings → Connectors → GitHub并检查是否选择了正确的分支。
- 选择Push Changes。
- 在推送更改期间保持页面打开。
- 当出现Changes pushed successfully时,选择View on GitHub并检查最新项目文件是否已存在。
Push Changes仅在 Atoms 中存在尚未发送到 GitHub 的更改时可用。当智能体正在工作,或你正在查看项目的旧版本时,该选项不可用。
一旦你选择Push Changes,更改会立即发送到 GitHub,而不会要求确认。 如果同一个文件在 Atoms 和 GitHub 中都已被修改,则 Atoms 中的版本优先,并会覆盖当前存储在 GitHub 中的版本。
将更新从 GitHub 拉取到 Atoms
与推送不同,拉取更改需要先确认。如果同一个文件在 GitHub 和 Atoms 中都已被修改,则 GitHub 中的版本优先,并会覆盖 Atoms 中的当前版本。
- 打开Settings → Connectors → GitHub。
- 检查Repository Status是否显示来自 GitHub 的新更改,以及是否选择了正确的分支。
- 选择Pull Updates。
- 阅读Pull May Affect Project警告。如果你希望将 GitHub 中的更改带入当前 Atoms 项目,请选择Confirm。
- 在拉取更改期间保持页面打开。
- 当出现Changes pulled successfully时,打开App 预览并测试项目中受这些更改影响的部分,以确保一切仍按预期运行。
Pull Updates仅在所选 GitHub 分支包含尚未拉取到 Atoms 的更改时可用。
断开 GitHub
当你不再希望 Atoms 访问已连接账户时,请断开 GitHub。GitHub 仓库及其文件将保留在 GitHub 中,但 Atoms 将无法再推送或拉取更改。
GitHub 授权适用于已连接账户。撤销访问权限会断开所有使用该 GitHub 账户的 Atoms 项目,因此在继续之前请检查你的其他项目。
- 打开Settings → Connectors → GitHub。
- 选择Disconnect。
- 在Disconnect GitHub确认框中,再次选择Disconnect。
- GitHub 应会自动打开相应的授权页面。如果没有,请在 GitHub 中前往Settings → Applications → Authorized OAuth Apps。
- 找到Atoms,选择其所在行右侧的...,然后选择Revoke。不要选择Revoke all;该操作会移除此页面中列出的所有已授权 OAuth 应用的访问权限。
- 按照 Github 要求完成所有必要的确认步骤。
- 返回 Atoms 并重新打开GitHub连接器,以确认该账户已不再连接。
在 GitHub 连接器中选择 Disconnect。
仅在 GitHub 中撤销 Atoms OAuth 应用。