搜索

第 8 章 安装和配置 Ansible 代码 bot

download PDF

Ansible 代码 bot 扫描 GitHub 存储库中托管的现有内容集合、角色和 playbook,并在有最佳实践或质量改进建议时主动创建拉取请求。

Ansible 代码 bot 扫描您的代码存储库,以推荐代码质量改进。它促进 Ansible 最佳实践,同时避免常见错误导致错误,或者使代码更难以维护。bot 自动向存储库提交拉取请求,这会主动向存储库所有者发送建议更改的内容。您可以配置 Ansible 代码 bot 来扫描现有的 Git 存储库(公共和私有)。

注意

您的机构必须具有 Red Hat Ansible Automation Platform 的有效订阅才能使用 Ansible 代码 bot。但是,IBM watsonx Code Assistant 不需要使用 Ansible 代码 bot。

安装 Ansible 代码 bot 后,您可以访问 Ansible 代码 bot 仪表板,该仪表板显示 bot 安装的所有存储库及其扫描状态。在控制面板中,您可以启动手动扫描、查看扫描历史记录并查看存储库。从 GitHub 中,您可以将调度配置为定期扫描存储库,并从中添加或删除存储库。如需更多信息,请参阅管理存储库扫描

重要

以下 GitHub 版本支持 Ansible 代码 bot:

以下示例是 Ansible 代码 bot 建议的代码建议:

  • 可用于已弃用的旧语法或实现模式的替代方法
  • 模块版本更改和更新,例如:

    • 添加任何新的所需参数
    • 标记已弃用的参数
    • 删除未使用的参数
  • 应用 YAML 最佳实践
  • 添加注释块
  • 在名称字段中修复 casing 问题

8.1. 安装 Ansible 代码 bot

安装 Ansible 代码 bot 以获取存储库的代码建议,然后登录 Ansible 代码 bot 仪表板以监控和管理您的存储库扫描。

流程

  1. 使用与您的机构关联的帐户登录 GitHub。
  2. 进入 Ansible 代码 bot GitHub 应用。
  3. 选择您希望应用程序访问的 Ansible 存储库:

    • 所有软件仓库 :提供读取所有存储库元数据的访问权限。
    • 仅选择软件仓库 :提供访问权限来只读取您选择的存储库的元数据。
  4. 可选:如果您只选择上一步中的 存储库,请选择您希望 Ansible 代码 bot 从 Select repositories 列表访问的存储库。
  5. Install & Authorize。此时会显示一条信息,用于指定在安装过程中为 bot 自动授予以下权限:

    • 对元数据的读访问
    • 对代码和拉取请求的读和写访问
  6. 出现提示时,以机构管理员身份登录到您的 Red Hat Single Sign-On 帐户。
  7. 登录到 Ansible 代码 bot 仪表板:

    1. Authorize Ansible code bot 页面中,验证您的帐户和存储库权限。
    2. Authorize Ansible

      Authorize Ansible code bot 页面中,会出现以下操作:

      • Ansible 代码 bot 会验证您是否是拥有 Red Hat Ansible Automation Platform 有效订阅的机构的一部分。
      • GitHub 请求读取权限,以访问与您的帐户关联的存储库。

成功授权后,您将登录到 Ansible 代码 bot 仪表板,该仪表板显示安装有 Ansible 代码 bot 的所有存储库及其扫描状态。如果您之前没有设置扫描调度,仪表板会显示没有关联的扫描历史记录的存储库。您可以通过启动手动扫描来扫描 Git 存储库,或者将调度配置为定期扫描存储库。您还可以添加用于扫描的存储库,或从被扫描的现有存储库中删除。如需更多信息,请参阅管理存储库扫描

8.1.1. 卸载 Ansible 代码 bot

如果您不再使用 Ansible 代码 bot,您可以从 GitHub 中卸载它。卸载后,您仍然可以访问 Ansible 代码 bot 仪表板,但您无法在仪表板或扫描存储库中看到存储库。

流程

  1. 使用与您的机构关联的帐户登录 GitHub。
  2. 在 GitHub 中,点您的配置集 photo > Settings
  3. 在 Integrations 下,点 Applications > Installed GitHub Apps
  4. 点 Ansible 代码 bot 应用程序旁边的 Configure
  5. Danger 区 区中点 Uninstall

    Ansible 代码 bot 应用程序从 GitHub 帐户卸载。

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.