Discord Notify Action

Welcome to the Discord Notify Action project repository. This project provides a GitHub Action for sending notifications to a Discord channel using a webhook. It is built with Node.js and MongoDB, and is fully containerized using Docker and Docker Compose.

Table of Contents

• Discord Notify Action
  • Table of Contents
  • Usage
  • Arguments
  • License
  • Contributing

Usage

To use this GitHub Action in your workflows, include the following step in your .github/workflows YAML file:

For a raw message:

notify:
  runs-on: ubuntu-latest
  steps:
    - name: Discord notification
      uses: cabrera-evil/[email protected]
      with:
        webhook_url: ${{ secrets.DISCORD_WEBHOOK }}
        title: 'GitHub Action'
        description: 'A new commit has been pushed.'
        include_image: 'true'
        username: 'GitHub'
        title_url: 'https://github.com/${{ github.repository }}/commit/${{ github.sha }}'

Arguments

The following arguments can be configured:

• webhook_url (required): The Discord Webhook URL.
• title (optional): The title of the notification.
• description (optional): The description of the notification.
• include_image (optional): A boolean value to include an image in the notification.
• avatar_url (optional): The URL of the avatar image to use in the notification.
• username (optional): The username to use in the notification.
• color (optional): The color of the notification.
• custom_image_url (optional): The URL of a custom image to include in the notification.
• title_url (optional): The URL to link the title to.

License

This repository is licensed under the MIT License. You are free to use, modify, and distribute as long as you include the original license text.

Contributing

We welcome and encourage contributions to enhance the functionality and usability of this project. Please contact the repository owner to discuss your ideas, or submit a pull request. All contributions will be reviewed and must meet the project's standards before being merged.