Spam Check GitHub Action

This GitHub Action, named Spam Check, is designed to help maintainers identify and filter out spam pull requests (PRs) in their repositories. By integrating this action into their GitHub workflows, maintainers can automatically flag potential spam, allowing them to focus on legitimate contributions.

Description

Spam Check leverages the GitHub Actions platform to scan incoming pull requests for signs of spam. It utilizes a Docker container to run the spam checking logic. This action is essential for open-source projects that receive a high volume of PRs and need a way to quickly sift through them to maintain project integrity.

Features

• Automatic scanning of pull requests for spam content.
• Utilizes a Docker container to isolate the checking process.
• Easy integration with existing GitHub workflows.

Usage

Create an OPENAI API key and add it to repository secrets.

To use this action in your GitHub repository, create a workflow file (e.g., .github/workflows/spam-check.yml) and include the following configuration:

name: Spam Check Workflow

on:
  pull_request:
    types: [opened, edited, reopened, synchronize]

jobs:
  spam-check:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Run Spam Checker
        uses: apoorvdwi/spam-check@v3.0
        with:
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          GITHUB_REPOSITORY: ${{ github.repository }}
          PR_NUMBER: ${{ github.event.pull_request.number }}
          MAX_FILES: 5
          FILES_TO_EXCLUDE: ''
          USE_GPT4: false

Examples

• PR with failed check - #3
• PR with success check - #4