Use Proofline commands on a pull request
Mention Proofline in a pull request comment, then write a command, to start a review, pause automatic reviews, record a decision on a finding, or ask for a fix. Proofline replies on the pull request with what it did, or why it changed nothing.
Before you comment#
You need write access to the repository. If you are a collaborator without write access, Proofline replies that write access is required, and nothing changes. A comment from someone who is not a collaborator gets no reply.
Write the command after the mention, for example @proofline status. To see the commands on GitHub, comment @proofline help.
Review the pull request#
revieworfull reviewreviews the pull request's current commit now. If a review of that commit is already running, Proofline reuses it. The Proofline check on that commit reports the review's progress and result.deep reviewreviews the current commit and every later push in more depth. See Review a pull request in depth.
If no review starts, the reply says why, for example because the pull request is closed, reviewing is off for the repository, or neither you nor the author has a Proofline seat.
Stop and resume automatic reviews#
stopstops automatic reviews of the pull request and cancels any review that is running. It also stops the pull request's research runs.resumerestarts automatic reviews from the next push.statuslists whether automatic reviews are stopped and who stopped them, the pull request's ignores, the latest review with its commit, and the open findings, numbered.
While automatic reviews are stopped, review still runs a review, and automatic reviews stay stopped.
Record a decision on a finding#
Reply on the thread Proofline opened for a finding, and say what you decided: dismiss it, accept its risk, mark it fixed, confirm it, or ask Proofline to explain it. On that thread, a plain reply such as fixed, dismiss, accept risk or confirm is enough; you do not need to mention Proofline. Away from the thread, mention Proofline and name the finding by the number status shows.
Proofline records the decision under your GitHub account and keeps the finding's earlier evidence. If a plain reply on the thread states no decision, Proofline records nothing and replies with the words that record one.
Ignore a path or risk domain on this pull request#
Comment ignore, then a path or a risk domain, then on this PR, for example @proofline ignore migrations/ on this PR. Proofline stops raising findings in that risk domain, or findings whose affected paths all sit under that path, on this pull request only. A finding that also affects other paths is still raised. Proofline still analyzes the change and records what it finds, and the ignore ends with the pull request.
Ask for a fix#
To ask for a fix, sign in to Proofline once with your GitHub account, and an organization administrator must turn on fix generation for the organization. Proofline writes and validates each fix in a sandbox. Nothing changes on the pull request until someone applies a validated fix.
- Reply
generate fixon a finding's thread to have a fix written and validated. The reply links to the proposal. - Reply
apply fixon the same thread to write the finding's validated fix at the pull request's current commit. The reply says whether the fix arrives as a commit on the pull request's branch or as a pull request into it. If the fix is held for review, apply it from its proposal page in Proofline. - Mention Proofline with
fix allto fix up to 10 open findings of the latest review together, most severe first. When the batch is done, Proofline adds one commit or pull request, and lists the findings it left out with the reason for each.
If Proofline cannot start a fix, the reply says why, such as fix generation being off for the organization or the finding having no validated fix at the current commit.
Run recipes, research, questions and investigations#
list recipeslists the finishing recipes, andrun recipe <name>proposes that recipe's change. See Use finishing recipes.research <question>researches a question from the pull request's pinned code and recorded environment evidence. See Read research and publish a candidate.- A question about the pull request, written after the mention, gets one answer with its citations.
investigate <symptom>investigates a production symptom. See Ask Proofline to investigate.