Guardian Self Assessment CLI tool
What?
self-assessment
is a tool that generates a list of PRs authored and reviewed by you.
Why?
Assessing oneself is hard - this tool aims to make the process a little bit easier.
It is not meant to be the be-all and end-all of the self-assessment journey. Use it as a starting point to remember your contributions to the Guardian.
Usage
- You need Rust to install
self-assessment
. Running the following command will install the Rust toolchain on your machine. If Rust is already installed, skip this step.
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
-
Run
cargo install self-assessment
to install the CLI tool. -
You can now use the CLI tool! But first, you need to generate a GitHub personal access token
👉 here👈
Set your preferred expiration date and make sure you grant the repo scopes (avoid "No expiration" for security reasons). Finally, click "Generate token".
NB: You will need to re-authenticate once the token expires.
- Set the access token by running the following command (replace
self-assessment --auth-token <AUTH_TOKEN>
- You can now run the CLI tool using the following syntax:
self-assessment --from <YYYY-MM-DD> --to <YYYY-MM-DD>
Both the --from
and --to
flags are optional.
If no flags are specified (i.e. if you just execute self-assessment
), you will get a list of all PRs with no time constraints. This is not recommended, as it is likely to incur GitHub's secondary rate limit (particularly if you've been at the Guardian a long time and are a prolific contributor). Omitting one of the two flags also works (e.g self-assessment --from 2021-10-01
).
If all goes well, you should see an automatically generated HTML page containing useful information about PRs authored and reviewed by you.
CLI information
self-assessment 0.1.0
USAGE:
self-assessment [OPTIONS]
OPTIONS:
-a, --auth-token
Github authentication token. This is needed to run the CLI
tool. You can get a personal access token at
https://github.com/settings/tokens/new [default: ]
-f, --from
Match PRs that were created after this date [default: *]
-h, --help Print help information
-t, --to
Match PRs that were created up until this date [default: *]
-V, --version Print version information