🚀 HacktoberShield is a 🔥 super-charged GitHub Action designed to protect your project during Hacktoberfest 🎃. It uses the power of OpenAI GPT 🤖 to evaluate incoming Pull Requests and keep spam away! 🚫
- 🔍 Identifies Changed Files: Never miss what has been altered in a PR.
- 📋 Runs Diff Checks: Get the full picture of every change.
- 🧠 Evaluates Using OpenAI GPT: Leveraging machine learning for accurate evaluations.
- 🚩 Flags Suspected Spam: Keeps your repo clean and pristine.
1️⃣ Create a .github/workflows/hacktobershield.yml file in your repository with:
name: Hacktber Shield
on:
pull_request:
types: [opened, synchronize]
jobs:
hacktoberShieldJob:
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
steps:
- name: Use HacktoberShield Action
uses: velocitatem/HacktoberShield@main # or specify a tag version instead of "main"
with:
openai_api_key: ${{ secrets.OPENAI_API_KEY }}
github_token: ${{ secrets.GITHUB_TOKEN }}2️⃣ Add the action steps to the YAML.
- 🌐 GitHub Actions enabled on your GitHub repository.
- 🔑 OpenAI API Key for the magic 🎩.
OPENAI_API_KEY: 🗝️ Your OpenAI API key.
🔒 Add this environment variable to your repository secrets.
Simply insert the action in your .github/workflows/hacktobershield.yml as demonstrated in the 🚀 Quick Start section.
📗 MIT License. Please see the LICENSE file for more information.