How a pull request gets checked.
- On every push
- When a pull request is opened or pushed to, SlopCop checks what it changes since it branched: the same change and the same rules as
slopcop checkon its head. - On the lines it changed
- Each new finding appears in Files changed on the line that raised it, with the rule, its severity and the file. Findings already in the code are counted, and never fail the check. The guide to reading a report says what counts as new.
- Before it merges
- Make SlopCop a required check in branch protection, and a pull request with new findings can’t merge until they’re fixed. Re-run it from the pull request at any time.
- Never a false all-clear
- A rule that can’t finish leaves the check neutral, never green, and the check says which rules didn’t finish. A neutral check counts as passing for GitHub, so read its details before you merge.
Before you connect GitHub.
- On for connected repositories
- A repository reached through your workspace’s GitHub connection starts with Check pull requests on. A workspace owner can turn it on for every reachable repository at once, and a manager can turn it off for one. The guide to checking pull requests has each step.
- What it costs
- A pull request check is charged as any check is. A workspace gets 1,000 free checks each calendar month, and each check after those costs $0.001. Repositories are free. Pricing has the credit packs and what happens when they run out.
- Pull requests from forks
- A fork’s pull request is checked when its author is an owner, member or collaborator of the repository. Anyone else’s gets a check that says it wasn’t checked.
- Nothing to run in your CI
- The SlopCop GitHub App posts the check. It asks once for permission to post checks, and nobody signs in again. You add no workflow and store no token. To choose your own failure threshold or output format, run the CLI in your own CI.
