semantic-release-discord-notifier

A semantic-release plugin to send release notifications to Discord.

:note: This plugin is still in development and may not work as expected. Please report any issues and feature requests you encounter.

Installation

npm install semantic-release-discord-notifier

Usage

The plugin can be configured in the semantic-release configuration file:

Below is an example of a .releaserc file that configures semantic-release-discord-notifier:

{
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    ["semantic-release-discord-notifier", {
      "webhookUrl": "https://discord.com/api/webhooks/your-webhook-url",
      "changelogTooLongMessage": "Changelog too long, check the GitHub release page for details.",
      "embedJson": {
        "username": "My app",
        "avatar_url": "https://avatars.githubusercontent.com/u/211977?s=400&u=c9d3d971f2adcf6ab6045bc698c7dc70eebf04fe&v=4",
        "content": "# :rocket: ${nextRelease.version} just dropped",
        "embeds": [
          {
            "title": "What changed?",
            "description": "${nextRelease.notes}",
            "color": 7377919,
            "footer": {
              "text": "Some additional information"
            }
          }
        ],
        "components": [
          {
            "type": 1,
            "components": [
              {
                "type": 2,
                "style": 5,
                "label": "Follow on twitter",
                "url": "https://twitter.com/vsbmeza"
              },
              {
                "type": 2,
                "style": 5,
                "label": "Sponsor the project",
                "url": "https://github.com/sponsors/meza"
              }
            ]
          }
        ]
      }
    }]
  ]
}

Configuration

Environment Variables

| Variable | Description | |-------------------|--------------------------------------------| | DISCORD_WEBHOOK | The Discord webhook URL (if not in config) |

Options

| Option | Description | Default | |---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------| | webhookUrl | The Discord webhook URL | undefined | | embedJson | A custom Discord webhook JSON object | See below | | branches | List of branch names, branch objects, or semantic-release branch globs that should trigger notifications | undefined | | changelogTooLongMessage | Message used instead of ${nextRelease.notes} when the changelog is longer than Discord allows in an embed description | Changelog too long, check the GitHub release page for details. |

You can use https://message.style/app/editor or similar to generate the embedJson object.

The embedJson object is the JSON object that will be sent to Discord. Aside from the (Variable Substitution)[#variable-substitution] mentioned below, what you speficy here will go directly to Discord unchanged.

When branches is provided, notifications are sent only when the current Git branch matches one of the configured names or patterns (the same string, object name, and extglob syntax semantic-release supports for its own branches configuration). This allows you to restrict notifications to main, release branches like release/*, prerelease branch objects like { "name": "beta", "prerelease": true }, or versioned branches such as v+([0-9])?(.{+([0-9]),x}).x.

When ${nextRelease.notes} is longer than Discord's embed description limit, the plugin replaces only that changelog value with changelogTooLongMessage. The surrounding webhook JSON, including custom content, embed titles, fields, and buttons, is left unchanged.

If embedJson is not provided, the default embed will be:

{
  "content": "New Release: ${nextRelease.version}",
  "embeds": [
        {
          "title": "What changed?",
          "description": "${nextRelease.notes}",
          "color": 7377919
        }
    ]
}

Variable Substitution

The plugin supports variable substitution in the embedJson. You can use ${variable} syntax to insert values from the semantic-release context. For example, ${nextRelease.version} will be replaced with the version of the new release.

Available context variables include:

• nextRelease.version
• nextRelease.notes
• branch.name
• commits (array of commit objects)
• lastRelease.version

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.