开始使用 Shopify GitHub 集成

Shopify GitHub 集成让您可以使用 Git 对主题代码进行修改和跟踪。本教程介绍如何安装 Shopify GitHub 应用程序,将一个分支连接为主题,测试连接,然后发布主题。

开始使用前

在开始使用 Shopify GitHub 集成之前,请执行以下操作:

  • 如果您想使用开发商店创建主题,请创建或登录 Shopify 合作伙伴账户,然后创建一个开发商店。
  • 确保您的账户具有管理主题权限或您要开发的商店的主题权限,或者您是该商店的所有者。
  • 注意要连接的 GitHub 仓库和分支。该分支必须与默认的 Shopify 主题文件夹结构相匹配。您无法在 Shopify 管理中从主题创建仓库或分支。
    • 如果您还没有主题,请考虑使用 Shopify CLI 初始化一个主题。
    • 如果您想使用店铺中已有的主题,可以下载一个主题的 ZIP 压缩包,然后创建一个包含其内容的仓库。
    • 如果资源库属于某个组织,而您没有安装应用程序的权限,那么在连接主题之前,您需要请求管理员批准安装。您也可以请求管理员为您的组织安装应用程序。

第1步:连接到GitHub组织或账户

要开始使用 Shopify GitHub 集成,您需要将 GitHub 组织或账户连接到 Shopify。

如果您使用的是新开发的商店,那么在商店创建后的首次登录中就无法设置 GitHub 集成。要成功连接到 GitHub,您需要先退出商店,然后通过 “合作伙伴控制面板 “再次登录。

注意事项
对于已启用 SSO 的 GitHub 组织,在连接您的组织前需要激活 SAML 会话。

  1. 在 Shopify 管理页面,进入Online Store > Themes
  2. Theme library部分,单击 Add theme > Connect from GitHub.
  3. Connect theme 窗格中,点击 Log in to GitHub
  4. 输入 GitHub账号密码。
  5. 系统会提示您授权并安装 Shopify GitHub 应用程序。选择是在个人账户上安装,还是为组织安装。
  6. 如果是为组织安装应用程序,请选择是为所有库安装应用程序,还是指定某个库。Shopify 建议只授予您想要使用此集成的特定库的访问权限。了解更多关于授权 Shopify 访问 GitHub 仓库的信息。

提示
您可以按照相同的步骤连接其他账户和组织,然后选择添加组织。

第2步:将分支连接到主题

要在 Shopify 后台中将分支连接到主题,您需要选择一个分支。分支的内容会作为新主题添加到主题库中。

50 MB 或更大的分支无法连接到 Shopify。

  1. 在 Shopify 管理页面,进入 Online Store > Themes
  2. Theme library部分,点击 Add theme > Connect from GitHub
  3. 如果出现提示,请登录 GitHub。
  4. 如果要连接属于某个组织的库,请选择库所属的组织。
  5. 选择要连接的,然后选择要连接的分支。

主题就会出现在你的主题库中。连接到 GitHub 的主题会在主题卡片上列出库、分支名称和最后提交时间。

初始连接完成后,您所选分支的所有提交都会被拉入主题,您通过 Shopify 后台所做的所有更改都会推送到该分支。

步骤 3:测试连接

为了确保您的分支和版本库之间的连接正常,您可以对主题做一个小改动,然后验证分支中是否有提交。

  1. 在 Shopify 后台,进入Online Store > Themes.。
  2. 在连接到 GitHub 的主题上,点击 Customize.
  3. 更改主题中的任何设置。例如,在 Dawn中,可以更改公告栏上的文字。
  4. 单击保存,然后退出主题编辑器。
  5. 在主题库的主题卡上,单击分支名称导航到 GitHub。
  6. 注意最近的提交。该提交的作者应该是 shopify 机器人。

如果需要,你也可以从本地机器向分支推送变更。将提交推送到分支后,主题上的最后保存日期就会更新,主题中也能看到更改。

第 4 步:发布主题

要跟踪已发布主题的更改,你需要从主题库中发布一个连接到 GitHub 分支的主题。你可以将主分支或主分支添加为一个主题,这样就可以使用 Git 分支和合并策略保持已发布主题的更新。进一步了解主题的分支策略。

您可以通过 Shopify后台或 Shopify CLI 手动发布主题

GitHub 连接故障排除

在极少数情况下,当您的组织已启用 SSO 时,与 GitHub 账户的连接可能会失败,但会显示连接成功。要重建连接,您可以通过 GitHub 设置撤销 Shopify GitHub 应用程序对您账户的访问权限,然后确保您已登录并有一个活动的 SAML 会话,然后再完成设置过程。

您可以通过浏览器访问 https://github.com/orgs/ORGANIZATION-NAME/sso 来创建 SAML 会话。将 ORGANIZATION-NAME 替换为你的组织名称。

有关 SAML 身份验证的更多信息,请参阅 GitHub 文档

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注