例如

ghctl repo config get gitsudo-io/ghctl

将输出类似以下内容

teams:
  a-team: maintain
environments:
  gigalixir:
    reviewers:
    - aisrael
    - gitsudo-io/a-team
branch_protection_rules:
  main:
    require_pull_request:
      required_approving_review_count: 1
      dismiss_stale_reviews: false
      require_code_owner_reviews: false
    required_status_checks:
      strict: false
      contexts:
      - mix/test
    enforce_admins: false

ghctl repo config get的输出适合与ghctl repo config apply一起使用（见下文）。

将GitHub仓库配置应用到仓库中

ghctl repo apply "{owner}/{repo}" --config-file {config_file}将从指定的YAML配置文件中读取配置并应用到指定的GitHub仓库。

配置文件应该是YAML文件，目前支持以下部分

仓库团队权限

teams:
  {team-slug}: {permission}

其中 {team-slug} 是GitHub上的团队slug，而 {permission} 是以下之一： pull、triage、push、maintain 或 admin。

示例

teams:
  a-team: maintain

当应用到仓库时，将授予 a-team 团队仓库的 maintain 权限。

仓库协作者

collaborators:
  {username}: {permission}

其中 {username} 是GitHub用户名，而 {permission} 是以下之一： pull、triage、push、maintain 或 admin。

示例

collaborators:
  aisrael: admin

部署环境

environments:
  {environment}:
    reviewers:
      - {username}, or
      - {org}/{team-slug}

其中 {environment} 是部署环境的名称，{username} 是GitHub用户名，或者，如果提供了 {org}/{team-slug}，则引用GitHub组织和团队。

示例

environments:
  gigalixir:
    reviewers:
      - aisrael
      - gitsudo-io/a-team

当应用到仓库时，将创建部署环境并相应配置其审查者。

分支保护规则

branch_protection_rules:
  {branch name}:
    required_status_checks:
      contexts:
        - {status check name}
        - ...
    require_pull_request: true

其中 {branch name} 是要保护的分支名称。

required_status_checks 是可选的，如果提供，则要求在允许合并分支之前通过指定的状态检查。在 contexts 列表中通过名称指定任何必需的状态检查。

require_pull_request 是可选的，如果提供，则要求所有提交都必须通过拉取请求进行。

示例

branch_protection_rules:
  main:
    required_status_checks:
      contexts:
        - "mix/test"
        - "mix/credo"
    require_pull_request: true

当应用到仓库时，将保护 main 分支，并在合并之前要求拉取请求，并要求在允许合并分支之前通过 mix/test 和 mix/credo 状态检查。

完整示例

假设有一个包含以下内容的 gitsudo.yaml 文件

teams:
  a-team: maintain
collaborators:
  aisrael: admin
environments:
  gigalixir:
    reviewers:
      - aisrael
      - gitsudo-io/a-team
branch_protection_rules:
  main:
    required_status_checks:
      contexts:
        - "mix/test"
    require_pull_request: true

当我们执行

ghctl repo config apply gitsudo-io/gitsudo --access-token ${GHCTL_ACCESS_TOKEN} -F gitsudo.yaml

然后我们应该看到以下类似的输出

[2023-06-16T18:33:34Z INFO ] Added team a-team with permission Maintain to repository gitsudo-io/gitsudo
[2023-06-16T18:33:34Z INFO ] Updated collaborator aisrael with permission admin to repository gitsudo-io/gitsudo
[2023-06-16T18:33:34Z INFO ] Created deployment environment gigalixir in repository gitsudo-io/gitsudo
[2023-06-16T18:33:35Z INFO ] Applied branch protection rules to branch main in repository gitsudo-io/gitsudo
[2023-06-16T18:33:35Z INFO ] Applied configuration to gitsudo-io/gitsudo

ghctl GitHub操作

ghctl的GitHub操作

输入

gitsudo -io/ghctl 也是一个GitHub操作，它允许你在GitHub操作工作流程中使用 ghctl 工具。

例如，给定以下工作流程

name: Configure ghctl repository
on: 
  push:
  workflow_dispatch:

jobs:
  ghctl-repo-config-apply:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: gitsudo-io/ghctl@main
        with:
            args: repo config apply gitsudo-io/gitsudo --access-token ${{ secrets.GHCTL_ACCESS_TOKEN }} -F gitsudo.yaml

然后执行上述工作流程将执行等效于之前的命令。