# GitHub specific CI scripts

This folder contains [`actions/github-script`](https://github.com/actions/github-script)-based TypeScript code.
It provides a `nix-shell` environment to run and test these actions locally.

To run any of the scripts locally:

- Enter `nix-shell` in `./ci/github-script`.
- Ensure `gh` is authenticated.

## Check commits

Run `./run commits OWNER REPO PR`, where OWNER is your username or "NixOS", REPO is the name of your fork or "nixpkgs" and PR is the number of the pull request to check.

## Labeler

Run `./run labels OWNER REPO`, where OWNER is your username or "NixOS" and REPO the name of your fork or "nixpkgs".

## Reminders

Run `./run reminders OWNER REPO PR` to post the reminders that apply to the paths a pull request touches.

To add a reminder, write the review body to `reminders/KEY.md` and list KEY with its path regexes in `reminders.ts`.