How To: Check a PR using the Hyaline CLI

Purpose

Use hyaline to check a pull request in GitHub.

Prerequisite(s)

Steps

1. Check In Hyaline Configuration

Create a Hyaline Configuration File and check it into your GitHub repository.

Make sure you don’t check in any secrets, like the LLM Provider Key or the GitHub Token. Instead, setup the configuration to pull them from the environment.

See config reference for more information on creating a configuration file and referencing secrets.

2. Set Up Secrets

For each environment variable used in the Hyaline configuration that references a secret, set that variable up to be pulled in as a secret in GitHub.

3. Create Workflow File

Create a GitHub Workflow file to run when a pull request is updated. You can see an example file in the GitHub Actions reference.

Alternatively you could set Hyaline up to be run manually on dispatch.

Next Steps

Visit Config Reference or GitHub Actions Reference.