Skip to main content

GitHub_Commit-Macro.png GitHub Commit (GitHub 提交工具)

可使用 GitHub 提交工具通过 GitHub API 将文件、文件目录或者使用该文件或文件目录的工作流提交到 GitHub 存储库。

提示

此工具不会随 Alteryx Designer 自动安装。要使用此工具,请从 Alteryx Marketplace 下载。

工具组件

“GitHub 提交”有两个锚点:

  • 输入锚点:使用可选的输入锚点将字段传递到“GitHub 提交工具”中。如果使用此输入,传入数据流需要包含:

    • 文件路径:文件所在的本地目录路径。

    • 目标路径:GitHub 存储库中要将文件提交到的目标位置。

      • 如果存在嵌套文件夹,则用正斜杠 (/) 进行分隔。例如,Alteryx/Macros/GitHubCommit.yxmc

      • 如果将目标路径留空(批量提交模式)或使用默认文本(自提交模式),则您可以提交到存储库的根目录。

  • 输出锚点:输出锚点会返回由 API 返回的提交结果。

配置工具

使用工具配置窗口配置进行 API 调用所必需的字段。

模式

使用 Mode(模式)选项卡选择您的提交模式:Batch Commit(批量提交)Self Commit(自提交)

Disable macro(禁用宏指令):选中此复选框可禁用 GitHub 提交并防止其进行任何提交。结果窗口中将显示一条警告消息,指示该工具已禁用。

批量提交

使用批量提交模式将本地文件提交到指定的 GitHub 存储库。可以使用此选项提交单个文件或一组文件。可以使用目录输入工具提交整个文件夹。

批量提交要求您通过两个可用的下拉列表映射文件路径和目标路径字段。

自提交

使用自提交模式将使用了宏指令的工作流提交到指定的 GitHub 存储库。将 GitHub 提交添加到已完成的工作流,配置并运行。此模式使用环境变量来获取用于进行提交的工作流的文件路径和名称。请注意,在运行 GitHub 提交之前,必须保存对工作流的任何更改,否则这些更改不会反映在提交中。

自提交要求您通过 Target GitHub Directory(目标 GitHub 目录)下拉列表映射目标路径字段。

配置

使用配置选项卡提供 GitHub 所有者、存储库和分支详细信息。

  • GitHub Repo Owner (username)(GitHub 存储库所有者(用户名)):输入目标存储库所有者的 GitHub 用户名。这不能是您的用户名。如果您要提交到其他人的存储库,请在此处使用他们的用户名。

  • GitHub Repository Name(GitHub 存储库名称):输入要提交文件的存储库名称。

  • Branch(分支):输入要在其中进行提交的分支的名称。

    • Is protected(受保护):如果分支受保护,请选中此复选框。

  • Commit Message (Required)(提交消息(必填)):输入要随您的提交显示的消息。请注意,即使您已禁用 GitHub 提交,如果将此项留空,工作流也会返回错误。

身份验证

使用身份验证选项卡提供您的 GitHub API 基址和访问令牌。

  • GitHub API base Address(GitHub API 基址):该工具默认会添加此基址,但您可以根据需要对其进行更新。

  • GitHub Personal Access Token(GitHub 个人访问令牌):输入您的 GitHub 个人访问令牌。有关个人访问令牌的详细信息,请访问 GitHub 文档