This guide shows what a Flow code review does on a pull request on GitHub. You will learn:

  • What the review posts, and how the "Flow review" check reads
  • Each state of the check, and what to do about it
  • The comments that start a review again

Each pull request gets a review when it opens, and each push gets a review of its new commits. The review posts one comment for each finding, on the changed line. A comment gives the severity, the lenses, the finding, its impact and the fix. Some comments also have a suggested change that you can commit from GitHub.

When a later push fixes a finding, the review replies "Addressed in" with the commit, and resolves the comment.

Each review has a check named "Flow review" in the checks of the pull request. Its title counts the open findings by severity. Its summary says if a critical or major finding is open, names the agent and the model, lists the tasks of the review, and links to the logs of the run.

The Flow review check on GitHub: the title "1 minor open", the summary, the task list of twelve tasks and the link to the run logs

The check fails while a critical or major finding is open. To block the merge of such a pull request, make "Flow review" a required check in the branch protection or the ruleset of your default branch.

Each state is the title of the check, with its result on GitHub.

Reviewingin progress
The review runs, and the title counts the tasks that are done. A review takes a few minutes.
no open findingssuccess
The review ended, and no finding is open.
2 minor opensuccess
The review ended. The open findings are minor or nits, so the check passes. Read the comments, and fix what you agree with.
1 critical, 1 major openfailure
The review ended, and a critical or major finding is open. Fix the findings, or accept them. See Accepting a finding.
Waitingqueued
You pushed while an earlier push was under review. This push waits for that review to end, and its review then starts on its own.
Supersededskipped
A newer push came while this one waited. The newer push gets the review.
Not reviewedskipped
The pull request was closed before its review started. Reopen it to get a review.
The review did not finishneutral
The run stopped before it posted the findings. A neutral check does not block the merge. Re-run the check, or comment @adonisjs-flow full review.
The review did not startfailure
The workflow failed before the review, for example because a secret is missing. The summary names the cause. Fix it, then re-run the check. "The review stopped" is the same failure after the review started.
The Flow review workflow is missingneutral
The default branch has no .github/workflows/flow-review.yml. Merge the setup pull request. See GitHub setup.
This account has no Flow licenceneutral
The installation of the GitHub App is not connected to a Plus membership, or the membership ended. Connect the installation in your dashboard, or renew your membership.
Flow couldn't confirm the licence. Re-run the review.neutral
Plus did not answer in time. Re-run the check.

Comment on the pull request, with the command as the first line of the comment. Only people with write access to the repository can ask. Flow reacts with 👍 when it takes the request. When it refuses one, it reacts with 👎 and replies with the reason.

After the first review, each push gets a review of its new commits only. To review the whole pull request again, for example after a rebase, after you change the settings or the lenses, or after a review that did not finish, comment:

@adonisjs-flow full review

A review reports at most maxFindings findings, the most severe first. To review every change again and report each finding, comment:

@adonisjs-flow full review all

You need no comment. Each push gets its review on its own.

You need no comment either. Add the finding to accepted in .flow/review.yml, or write a flow-allow comment above the code. See Accepting a finding.

Local reviews

Review your branch on your computer, and write an HTML report.

Configuration

The settings of the review, and accepting a finding.