Guardian Self Assessment CLI 工具

是什么？

self-assessment 是一个工具，可以生成您撰写的和审查的 PR 列表，以及您被分配的 Trello 板和卡片的可选报告。

为什么？

自我评估很难 - 这个工具旨在使这个过程变得容易一些。
它并不是自我评估旅程的全部。将其用作记住您对 Guardian 贡献的起点。

如何？

1. 您需要 Rust 来安装 self-assessment。运行以下命令将在您的计算机上安装 Rust 工具链。如果 Rust 已经安装，请跳过此步骤。

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

2. 运行 cargo install self-assessment 以安装或更新 CLI 工具到最新版本。

3. 现在您可以使用 CLI 工具了！但首先，您需要生成 GitHub 个人访问令牌 👉 这里 👈
   这对于工具访问 Guardian 组织中私有仓库内的拉取请求是必需的。
   设置您首选的过期日期，并确保您授予 repo 权限（出于安全原因，请避免“无过期”）。然后，单击“生成令牌”。
   令牌创建后，您可能需要授权 guardian 组织访问此令牌。单击“配置 SSO”，然后单击 guardian 组织旁边的“授权”按钮。
   注意：令牌过期后，您将需要重新认证。
   

4. 通过运行以下命令设置访问令牌（将 <TOKEN> 替换为生成的令牌）

self-assessment auth <TOKEN>

5. 现在您可以使用以下语法运行 CLI 工具

self-assessment generate-report --from <YYYY-MM-DD> --to <YYYY-MM-DD>

--from 和 --to 标志都是可选的。 如果您想将 Trello 板和卡片包含在报告中，请阅读Trello 报告部分。
如果没有指定任何标志（即您仅执行 self-assessment generate-report），您将获得一个无时间限制的所有PR列表。这不建议这样做，因为这很可能会触发GitHub的二级速率限制（尤其是如果您在《卫报》工作很长时间并且是高产贡献者）。省略两个标志中的任何一个也有效（例如 self-assessment generate-report --from 2021-10-01）。

如果一切顺利，您应该会看到一个包含您所编写和审阅的PR的有用信息的自动生成的HTML页面。

Trello报告

为了显示分配给您的Trello卡，您需要使用Trello API密钥和令牌配置CLI。

步骤1

您可以通过登录Trello，然后访问https://trello.com/app-key（请注意，如果您未登录，此页面将引发错误）来获取密钥。请记下此密钥。

步骤2

从同一页面，点击生成服务器令牌的链接。

您将被带到生成服务器令牌的页面，默认设置为永不过期（authorize?expiration=never）。出于安全原因，强烈建议您将URL中的查询参数更改为authorize?expiration=30days。

一旦您获得了API密钥和服务器令牌，请在终端运行以下命令

self-assessment trello-auth <API_KEY> <TOKEN>

从终端运行self-assessment generate-report现在将生成一个报告，包括分配给您的Trello卡以及您所编写和审阅的GitHub拉取请求。完全支持--from <YYYY-MM-DD>和--to <YYYY-MM-DD>标志。

self-assessment 2.1.0
A CLI tool that generates a list of pull requests raised and reviewed in the Guardian's GitHub
organisation, as well as an optional summary of the user's Trello boards and cards.

USAGE:
    self-assessment <SUBCOMMAND>

OPTIONS:
    -h, --help       Print help information
    -V, --version    Print version information

SUBCOMMANDS:
    auth               Authenticate to Github. This is needed for the CLI tool to access the
                       Guardian's private repositories to which the user has access. You can get
                       a personal access token at <https://github.com/settings/tokens/new>
    generate-report    Generate a report containing a list of PRs authored and reviewed by you,
                       as well as an optional report of Trello boards and cards you are assigned
                       to. For more information, run self-assessment generate-report --help
    help               Print this message or the help of the given subcommand(s)
    trello-auth        Authenticate to Trello. An API key and a server token are required. For
                       more information, run self-assessment trello-auth --help