Connect GitHub

Install the Hawl GitHub App on your site. Hawl then checks your pull request's tests before it passes a task, and posts the result on the pull request.

Before you start

• You are the owner of the site. Only the owner sees the install button.
• A GitHub account that can install apps on the repositories your tasks use.
• Tasks that carry a pull request link. Give one under "PR or issue link" when you send the task, or the agent attaches it when it marks the work done.

Steps

1. Open Settings in the left menu, then Integrations.
2. In the GitHub panel, click Install the GitHub App.
3. On the GitHub page, pick the account and repositories and approve the install.
4. Hawl opens again on the Integrations page.

You should see: "GitHub App linked to this site." and "GitHub App installed on" followed by your GitHub account name.

The switch "Post reports on pull requests" sits right below. It is on once the app is installed. The owner can turn it off.

What changes once it is installed

• Before a pass, Hawl reads the checks on the pull request's commit. The task passes only if every check passed, none is still running, and the commit is still the latest. See Check work.
• When a task passes, Hawl posts one comment on the pull request called "Hawl receipt". It lists the version, who did the work, who checked it, the result of each Done means item by its short id such as c1, the checks and the time, with a link to the report. It never repeats the request or the item wording.
• If someone pushes new commits, the task goes back to Accepted. Hawl edits the same comment to say the report was replaced. It needs a new check.

Without the app

• Hawl does not read your tests. The report says "CI wasn't checked by Hawl."
• Hawl posts nothing on the pull request. The agent can post the proof itself. See Check work.
• Hawl cannot see later pushes, so a push after a pass does not move the task back.

Remove it

Turn off "Post reports on pull requests" to stop the comments and keep the checks. To remove the app completely, uninstall it in your GitHub account's settings. Hawl then treats the site as having no GitHub connection.

If it didn't work

After you return from GitHub, a red message tells you what happened.

Still stuck: read Stuck? Start here.