0.0.1 • Published 10 months ago

semantic-release-weapp v0.0.1

Weekly downloads
-
License
SEE LICENSE IN LI...
Repository
github
Last release
10 months ago

semantic-release-weapp

npm

Post feishu(飞书) notifications to a webhook on success or failure of a semantic-release job

StepDescription
verifyConditionsVerify the FEISHU_WEBHOOK_URL environment variable is set.
successSend a formatted message to the feishu webhook provided with information about the most recent release
failSend a formatted message to the feishu webhook if the release fails

Installation

yarn add --dev semantic-release-weapp

Usage

Add the following to your release.config.js

  "plugins": [
    // ...
   ["semantic-release-weapp", {
       // 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 FEISHU_WEBHOOK_URL. The hook is expected to contain https://open.feishu.cn/open-apis/bot/v2/hook/ in the URL. Without this, your release will fail because the plugin won't know where to post to.

Options

PropertyTypeDefaultExampleDescription
platformsString[]undefined"platforms": ["brew", "npm"]Available platforms that the package can be downloaded from. Can be anything. Supported emoji
skipCommitStringundefined"skipCommit": "^fix\\(deps\\):"Skips notifying when regex matches at least one commit in the release
semverFilterString[]["major", "minor", "patch"]"semverFilter": ["major", "minor"]Skips releases that do not match one of the configured types
fullReleaseNotesBooleantrue"fullReleaseNotes": falseProvides the full release notes in feishu instead of a link to the release notes
failureMessageBooleanfalse"failureMessage": trueSends message when the release failed