action.yaml

name: anti-slop
description: A GitHub action that detects and automatically closes low-quality and AI slop PRs.
author: peaklabs-dev

branding:
  icon: slash
  color: orange

inputs:
  # Repo Auth Token
  github-token:
    description: GitHub token used to authenticate API requests.
    required: true
    default: ${{ github.token }}

  # General Settings
  max-failures:
    description: Number of check failures needed before failure actions are triggered.
    required: false
    default: "4"

  # PR Branch Checks
  allowed-target-branches:
    description: Newline-separated target branch patterns to allow. Empty allows all branches.
    required: false
    default: ""
  blocked-target-branches:
    description: Newline-separated target branch patterns to block.
    required: false
    default: ""
  allowed-source-branches:
    description: Newline-separated source branch patterns to allow. Empty allows all branches.
    required: false
    default: ""
  blocked-source-branches:
    description: Newline-separated source branch patterns to block.
    required: false
    default: |
      main
      master

  # PR Size Checks
  max-changed-files:
    description: Maximum number of changed files allowed in the PR. 0 disables this check.
    required: false
    default: "50"
  max-changed-lines:
    description: Maximum number of changed lines (additions + deletions) allowed in the PR. 0 disables this check.
    required: false
    default: "10000"

  # PR Quality Checks
  max-negative-reactions:
    description: Maximum number of negative reactions (thumbs down + confused) allowed on the PR. 0 disables this check.
    required: false
    default: "0"
  require-maintainer-can-modify:
    description: Require the PR to allow maintainers to push to the source branch.
    required: false
    default: "true"

  # PR Title Checks
  require-conventional-title:
    description: Require PR titles to follow Conventional Commits format (e.g. 'feat:', 'fix:', 'feat(scope):').
    required: false
    default: "false"

  # PR Description Checks
  require-description:
    description: Require a non-empty PR description.
    required: false
    default: "true"
  max-description-length:
    description: Maximum character length for the PR description. 0 disables this check.
    required: false
    default: "2500"
  max-emoji-count:
    description: Maximum number of emojis allowed in the PR title and description. 0 disables this check.
    required: false
    default: "2"
  max-code-references:
    description: Maximum number of code references (file paths, function/method calls) allowed in the PR description. 0 disables this check.
    required: false
    default: "5"
  require-linked-issue:
    description: Require the PR to reference at least one issue in the PR description.
    required: false
    default: "false"
  blocked-terms:
    description: Newline-separated list of terms blocked from appearing in the PR description.
    required: false
    default: ""
  blocked-issue-numbers:
    description: Comma-separated list of issue numbers blocked from being referenced in the PR description.
    required: false
    default: ""

  # PR Template Checks
  require-pr-template:
    description: Require the PR description to follow the repository PR template structure.
    required: false
    default: "false"
  strict-pr-template-sections:
    description: Comma-separated PR template section headings (without '#') classified as strict. All checkboxes must be present and checked. Only applies when require-pr-template is enabled.
    required: false
    default: ""
  optional-pr-template-sections:
    description: Comma-separated PR template section headings (without '#') classified as optional. Can be removed from the description without failing the check. Only applies when require-pr-template is enabled.
    required: false
    default: ""
  max-additional-pr-template-sections:
    description: Maximum number of additional sections not in the template that are allowed in the PR description. 0 disables this check.
    required: false
    default: "0"

  # Commit Message Checks
  max-commit-message-length:
    description: Maximum character length for individual commit messages. 0 disables this check.
    required: false
    default: "500"
  require-conventional-commits:
    description: Require all commit messages to follow Conventional Commits format (e.g. 'feat:', 'fix:', 'feat(scope):').
    required: false
    default: "false"
  require-commit-author-match:
    description: Require every commit in the PR to be authored by the same GitHub user who opened the PR.
    required: false
    default: "true"
  blocked-commit-authors:
    description: Comma-separated list of blocked commit author usernames.
    required: false
    default: ""

  # File Checks
  allowed-file-extensions:
    description: Comma-separated list of allowed file extensions (e.g. '.ts,.js') for changed files. Empty allows all.
    required: false
    default: ""
  allowed-paths:
    description: Newline-separated file or folder paths to allow for changed files. Entries ending with '/' match folders. Empty allows all.
    required: false
    default: ""
  blocked-paths:
    description: Newline-separated file or folder paths to block for changed files. Entries ending with '/' match folders.
    required: false
    default: |
      README.md
      SECURITY.md
      LICENSE
      CODE_OF_CONDUCT.md
  require-final-newline:
    description: Require all changed files to end with a newline character.
    required: false
    default: "true"
  max-added-comments:
    description: Maximum number of added comments in all changed files. 0 disables this check.
    required: false
    default: "10"

  # User Checks
  detect-spam-usernames:
    description: Detect usernames that match common spam patterns.
    required: false
    default: "true"
  min-account-age:
    description: Minimum GitHub account age in days. 0 disables this check.
    required: false
    default: "30"
  max-daily-forks:
    description: Maximum number of repositories forked by the user in any 24-hour window. 0 disables this check.
    required: false
    default: "6"
  require-public-profile:
    description: Require the PR author to have a public GitHub profile.
    required: false
    default: "true"
  min-profile-completeness:
    description: Minimum number of profile signals (name, email, bio, etc.) the user must have to pass. 0 disables this check.
    required: false
    default: "4"

  # Merge Checks
  min-repo-merged-prs:
    description: Minimum number of merged PRs in this repository from the author. 0 disables this check.
    required: false
    default: "0"
  min-repo-merge-ratio:
    description: Minimum merge/close PR ratio percentage in this repository. 0 disables this check.
    required: false
    default: "0"
  min-global-merge-ratio:
    description: Minimum merge/close PR ratio percentage across all repositories. 0 disables this check.
    required: false
    default: "30"
  global-merge-ratio-exclude-own:
    description: Exclude PRs to the author's own repositories from the global merge ratio calculation.
    required: false
    default: "false"

  # Filters
  # only-issue-types:
  #   description: Comma-separated list of issue types. Checks only run on issues with one of these types.
  #   required: false
  #   default: ""
  # only-labels:
  #   description: Comma-separated list of labels. Checks only run when ALL listed labels are present.
  #   required: false
  #   default: ""
  # only-pr-labels:
  #   description: Comma-separated list of labels on PRs. Checks only run when ALL listed labels are present.
  #   required: false
  #   default: ""
  # only-issue-labels:
  #   description: Comma-separated list of labels on Issues. Checks only run when ALL listed labels are present.
  #   required: false
  #   default: ""
  # any-of-labels:
  #   description: Comma-separated list of labels. Checks run when any listed label is present.
  #   required: false
  #   default: ""
  # any-of-pr-labels:
  #   description: Comma-separated list of labels on PRs. Checks run when any listed label is present.
  #   required: false
  #   default: ""
  # any-of-issue-labels:
  #   description: Comma-separated list of labels on Issues. Checks run when any listed label is present.
  #   required: false
  #   default: ""

  # Exemptions
  exempt-draft-prs:
    description: Exempt draft PRs from all checks.
    required: false
    default: "false"
  exempt-bots:
    description: Newline-separated list of bot usernames exempt from all checks.
    required: false
    default: |
      actions-user
      autofix-ci[bot]
      dependabot[bot]
      renovate[bot]
      github-actions[bot]
  exempt-users:
    description: Comma-separated list of GitHub usernames exempt from all checks.
    required: false
    default: ""
  exempt-author-association:
    description: Comma-separated list of GitHub author associations exempt from all checks.
    required: false
    default: "OWNER,MEMBER,COLLABORATOR"
  # exempt-teams:
  #   description: Comma-separated list of GitHub team slugs whose members are exempt from all checks.
  #   required: false
  #   default: ""
  exempt-label:
    description: Label name that exempts PRs and Issues from all checks when it is present.
    required: false
    default: "exempt"
  exempt-pr-label:
    description: Label name that exempts PRs from all checks when it is present.
    required: false
    default: ""
  # exempt-issue-label:
  #   description: Label name that exempts Issues from all checks when it is present.
  #   required: false
  #   default: ""
  exempt-all-milestones:
    description: Exempt all PRs and Issues that are assigned to any milestone.
    required: false
    default: "false"
  exempt-all-pr-milestones:
    description: Exempt all PRs that are assigned to any milestone.
    required: false
    default: "false"
  # exempt-all-issue-milestones:
  #   description: Exempt all Issues that are assigned to any milestone.
  #   required: false
  #   default: "false"
  exempt-milestones:
    description: Comma-separated list of milestone titles. PRs and Issues assigned to any listed milestone are exempt.
    required: false
    default: ""
  exempt-pr-milestones:
    description: Comma-separated list of milestone titles. PRs assigned to any listed milestone are exempt.
    required: false
    default: ""
  # exempt-issue-milestones:
  #   description: Comma-separated list of milestone titles. Issues assigned to any listed milestone are exempt.
  #   required: false
  #   default: ""

  # PR Success Actions
  success-add-pr-labels:
    description: Comma-separated list of labels to add to the PR on success.
    required: false
    default: ""

  # PR Failure Actions
  failure-remove-pr-labels:
    description: Comma-separated list of labels to remove from the PR on failure.
    required: false
    default: ""
  failure-remove-all-pr-labels:
    description: Remove all labels from the PR on failure.
    required: false
    default: "false"
  failure-add-pr-labels:
    description: Comma-separated list of labels to add to the PR on failure.
    required: false
    default: ""
  failure-pr-message:
    description: Comment posted on the PR when the maximum number of failures is reached. Empty posts no comment.
    required: false
    default: ""
  close-pr:
    description: Close the PR when the maximum number of failures is reached.
    required: false
    default: "true"
  lock-pr:
    description: Lock the PR conversation after closing.
    required: false
    default: "false"

  # Issue Close Actions
  # close-issue:
  #   description: Close the issue when the maximum number of failures is reached.
  #   required: false
  #   default: "true"
  # close-issue-reason:
  #   description: Reason used when closing the issue (e.g. 'not_planned', 'completed').
  #   required: false
  #   default: "not_planned"
  # lock-issue:
  #   description: Lock the issue conversation after closing.
  #   required: false
  #   default: "false"

  # Issue Failure Actions
  # failure-issue-message:
  #   description: Comment posted on the issue when the maximum number of failures is reached. Empty posts no comment.
  #   required: false
  #   default: ""
  # failure-remove-issue-labels:
  #   description: Comma-separated list of labels to remove from the issue on failure.
  #   required: false
  #   default: ""
  # failure-remove-all-issue-labels:
  #   description: Remove all labels from the issue on failure.
  #   required: false
  #   default: "false"
  # failure-add-issue-labels:
  #   description: Comma-separated list of labels to add to the issue on failure.
  #   required: false
  #   default: ""

outputs:
  total-checks:
    description: Total number of checks that were run.
  failed-checks:
    description: Number of checks that failed.
  passed-checks:
    description: Number of checks that passed.
  result:
    description: "Overall result: 'passed', 'failed', or 'skipped'."

runs:
  using: node24
  main: dist/index.mjs