daltonmenezes / discord-guardian-action

🤖 An action that fetches the list of malicious domains on Discord in different providers and creates/updates a JSON file with them from time to time.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

a green shield with a check symbol in the centerDiscord Guardian Action

🤖 This action fetches the list of malicious domains on Discord in different providers and creates/updates a JSON file with them from time to time.

patreon url license url


Features

  • 🤠 Creates/updates domain list from different providers
  • ✨ Accepts your own maintained list file to be joined in the domains.json
  • 👍 Accepts the custom filename and directory to save the domain list

Usage

As your app will consume the domains.json, it's recommended to you create an empty one with an empty array just to be filled when this action run, so your application can import this file without any problem.

Example: At src/data path in your repository, create a domains.json with the following content:

[]

And your workflow file should look like the following:

on:
  schedule:
    # At minute 0 past every 5th hour
    # https://crontab.guru/#0_*/5_*_*_*
    - cron: "0 */5 * * *"

jobs:
  discord_guardian_job:
    runs-on: ubuntu-latest
    name: Discord Guardian Job
    steps:
      - name: Checkout
        uses: actions/checkout@v2
        with:
          fetch-depth: 0
      - name: Discord Guardian Action
        uses: actions/discord-guardian-action@v1.1.0
        id: discord
        with:
          name: 'Your Name'
          email: 'your_email@domain.com'
          directory: src/data

Now, when this action runs for the first time, the domains.json will be filled. 🥳

Inputs

name

Required!

The commit author name.

email

Required!

The commit author email.

directory

Optional

The directory to output the domain list. Default is "."

fileName

Optional

The Name of the output JSON file containing the domain list. Default is "domains"

myDomainList

Optional

The Path to your own JSON list of domains file to be joined in the final domains.json

Example:

myDomainList: src/data/my-domains.json

Acknowledgment

This action is only possible thanks to the following projects:

✨ Don't forget to give them a star

License

MIT © Dalton Menezes

About

🤖 An action that fetches the list of malicious domains on Discord in different providers and creates/updates a JSON file with them from time to time.

License:MIT License


Languages

Language:TypeScript 88.9%Language:JavaScript 8.9%Language:Shell 2.3%