Semantic-release-discord-notifier NPM

semantic-release-discord-notifier

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

Installation

npm install semantic-release-discord-notifier

Usage

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

{
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    ["semantic-release-discord-notifier", {
      "webhookUrl": "https://discord.com/api/webhooks/your-webhook-url",
      "embedJson": {
        "title": "New Release: ${nextRelease.version}",
        "description": "${nextRelease.notes}",
        "color": 5814783
      }
    }]
  ]
}

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 embed JSON object	See below

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

{
  "title": "New Release: ${nextRelease.version}",
  "description": "${nextRelease.notes}",
  "fields": [
    { "name": "Branch", "value": "${branch.name}" },
    { "name": "Commits", "value": "${commits}" }
  ],
  "color": 5814783
}

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: