intuit/semantic-release-slack

A plugin for semantic-release that takes a Slack web hook and posts a message when a release is successful

@intuit/semantic-release-slack

---

Post slack notifications to a webhook on success or failure of a semantic-release job

Step	Description
verifyConditions	Verify the SLACK_WEBHOOK_URL environment variable is set.
success	Send a formatted message to the slack webhook provided with information about the most recent release
fail	Send a formatted message to the slack webhook if the release fails

Installation

yarn add --dev @intuit/semantic-release-slack

Usage

Add the following to your release.config.js

  "plugins": [
    // ...
   ["@intuit/semantic-release-slack", {
       // These are the available platforms that the package can be downloaded from
       "platforms": ["brew", "npm", "docker"]
   }]
  ],

Ensure you have a webhook url in your process.env under the name SLACK_WEBHOOK_URL. The hook is expected to contain https://hooks.slack.com in the URL. Without this, your release will fail because the plugin won't know where to post to.

Options

Property	Type	Default	Example	Description
platforms	String[]	undefined	"platforms": ["brew", "npm"]	Available platforms that the package can be downloaded from. Can be anything. Supported emoji
skipCommit	String	undefined	"skipCommit": "^fix\\(deps\\):"	Skips notifying when regex matches at least one commit in the release
semverFilter	String[]	["major", "minor", "patch"]	"semverFilter": ["major", "minor"]	Skips releases that do not match one of the configured types
fullReleaseNotes	Boolean	false	"fullReleaseNotes": true	Provides the full release notes in slack instead of a link to the release notes

semantic-release-slack's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Repository problems

These problems occurred while renovating this repository. View logs.

• WARN: Using npm packages for Renovate presets is now deprecated. Please migrate to repository-based presets instead.

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

• fix(deps): update dependency @atomist/slack-messages to v1.2.2
• fix(deps): update dependency aggregate-error to v3.1.0

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• fix(deps): update dependency debug to v4.3.1 [security]
• chore(deps): update dependency semantic-release to v17 [security]
• chore(deps): update dependency prettier to v1.19.1
• fix(deps): update dependency node-emoji to v1.11.0
• fix(deps): update dependency node-fetch to v2.7.0
• chore(deps): update circleci/node docker tag to v17
• chore(deps): update commitlint monorepo to v18 (major) (@commitlint/config-conventional, commitlint)
• chore(deps): update dependency eslint to v8
• chore(deps): update dependency eslint-config-airbnb to v19
• chore(deps): update dependency eslint-config-prettier to v9
• chore(deps): update dependency eslint-plugin-jest to v27
• chore(deps): update dependency eslint-plugin-prettier to v5
• chore(deps): update dependency husky to v9
• chore(deps): update dependency jest to v29
• chore(deps): update dependency lint-staged to v15
• chore(deps): update dependency prettier to v3
• chore(deps): update semantic-release monorepo (major) (@semantic-release/git, @semantic-release/github, @semantic-release/npm)
• fix(deps): update dependency @semantic-release/error to v4
• fix(deps): update dependency aggregate-error to v5
• fix(deps): update dependency node-emoji to v2
• fix(deps): update dependency node-fetch to v3
• fix(deps): update dependency read-pkg-up to v10
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

circleci

.circleci/config.yml

• circleci/node 8-browsers
• circleci/node 8-browsers
• circleci/node 10-browsers
• circleci/node 10-browsers

npm

package.json

• @atomist/slack-messages 1.1.1
• @semantic-release/error 2.2.0
• aggregate-error 3.0.1
• debug 4.1.1
• node-emoji 1.10.0
• node-fetch 2.6.13
• read-pkg-up 5.0.0
• @commitlint/config-conventional 8.3.6
• @semantic-release/git 7.0.18
• @semantic-release/github 5.5.8
• @semantic-release/npm 5.3.5
• commitlint 8.3.6
• eslint 6.8.0
• eslint-config-airbnb 18.2.1
• eslint-config-prettier 6.15.0
• eslint-plugin-import 2.29.1
• eslint-plugin-jest 23.20.0
• eslint-plugin-jsx-a11y 6.8.0
• eslint-plugin-prettier 3.4.1
• eslint-plugin-react 7.33.2
• husky 3.1.0
• jest 24.9.0
• lint-staged 9.5.0
• prettier 1.17.1
• semantic-release 15.14.0
• node >=8

---

• Check this box to trigger a request for Renovate to run again on this repository

Support fullReleaseNotes for Bitbucket

as I see, enabling "fullReleaseNotes" option provides the full release notes only from github.

fullReleaseNotes for npm does nothing

🐛 Bug Report

Using fullReleaseNotes has no effect:

To Reproduce

Use this config:

module.exports = {
    branches: ["master"],
    plugins: [
        "@semantic-release/commit-analyzer",
        "@semantic-release/release-notes-generator",
        "@semantic-release/changelog",
        "@semantic-release/npm",
        ["@semantic-release/exec", {
            publishCmd: "npm run set-version"
        }],
        ["@semantic-release/git", {
            assets: [
                "CHANGELOG.md",
                "package.json",
                "package-lock.json",
                "source/version.ts"
            ],
            message: "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
        }],
        "@semantic-release/gitlab",
        ["@semantic-release/exec", {
            publishCmd: "npm run deploy"
        }],
        ["@intuit/semantic-release-slack", {
            "platforms": ["npm"],
            "fullReleaseNotes": true
        }]
    ]
};

Expected behavior

Release notes should be included in slack.

Run npx envinfo

Paste the results here:

  System:
    OS: Linux 6.2 Ubuntu 22.04.3 LTS 22.04.3 LTS (Jammy Jellyfish)
    CPU: (24) x64 AMD Ryzen 9 5900X 12-Core Processor
    Memory: 38.36 GB / 62.70 GB
    Container: Yes
    Shell: 5.1.16 - /bin/bash
  Binaries:
    Node: 20.10.0 - /usr/bin/node
    Yarn: 1.22.10 - /usr/bin/yarn
    npm: 8.19.4 - ~/leadoo/bot-icons/node_modules/.bin/npm
  Managers:
    Apt: 2.4.11 - /usr/bin/apt
    pip3: 22.0.2 - /usr/bin/pip3
  Utilities:
    CMake: 3.22.1 - /usr/bin/cmake
    Make: 4.3 - /usr/bin/make
    GCC: 11.4.0 - /usr/bin/gcc
    Git: 2.34.1 - /usr/bin/git
    FFmpeg: 4.4.2 - /usr/bin/ffmpeg
    Curl: 7.81.0 - /usr/bin/curl
  Virtualization:
    Docker: 20.10.14 - /usr/bin/docker
    VirtualBox: 6.1.38 - /usr/bin/vboxmanage
  SDKs:
    Android SDK:
      API Levels: 30
      Build Tools: 30.0.3, 31.0.0
      System Images: android-30 | Google APIs Intel x86 Atom
  IDEs:
    Android Studio: AI-203.7717.56.2031.7935034
    Nano: 6.2 - /usr/bin/nano
    VSCode: 1.84.2 - /usr/bin/code
    Vim: 8.2 - /usr/bin/vim
  Languages:
    Bash: 5.1.16 - /usr/bin/bash
    Java: 11.0.21 - /usr/bin/javac
    Perl: 5.34.0 - /usr/bin/perl
    Python3: 3.10.12 - /usr/bin/python3
  Databases:
    MySQL: 0.22.04.1 - /usr/bin/mysql
    SQLite: 3.32.2 - /home/perry/Android/Sdk/platform-tools/sqlite3
  Browsers:
    Brave Browser: 119.1.60.125
    Chrome: 119.0.6045.199