# semantic-release-weapp

> 发布微信小程序的插件

Latest version **0.0.1** (published 2023-07-17) · SEE LICENSE IN LICENSE.md license · 0 weekly downloads

## Install

```sh
npm install semantic-release-weapp
pnpm add semantic-release-weapp
yarn add semantic-release-weapp
bun add semantic-release-weapp
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2023-07-17 |
| First published | 2023-07-17 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN LICENSE.md |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 6 |
| Unpacked size | 23.3 KB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | David Aghassi |
| Maintainers | mark_npm |

## Links

- npm: https://www.npmjs.com/package/semantic-release-weapp
- Repository: git@github.com:WumaCoder/semantic-release-weapp
- npm.io page: https://npm.io/package/semantic-release-weapp

## Dependencies (6)

- [debug](https://npm.io/package/debug.md) 4.1.1
- [node-emoji](https://npm.io/package/node-emoji.md) 1.10.0
- [node-fetch](https://npm.io/package/node-fetch.md) 2.6.1
- [read-pkg-up](https://npm.io/package/read-pkg-up.md) 5.0.0
- [aggregate-error](https://npm.io/package/aggregate-error.md) 3.0.1
- [@semantic-release/error](https://npm.io/package/@semantic-release/error.md) 2.2.0

## Recent versions

- 0.0.1 (latest) — 2023-07-17

## README

# semantic-release-weapp

[![npm](https://img.shields.io/npm/v/semantic-release-weapp.svg)](https://www.npmjs.com/package/semantic-release-weapp)
---

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

| Step               | Description                                                                                            |
| ------------------ | ------------------------------------------------------------------------------------------------------ |
| `verifyConditions` | Verify the `FEISHU_WEBHOOK_URL` environment variable is set.                                           |
| `success`          | Send a formatted message to the feishu webhook provided with information about the most recent release |
| `fail`             | Send a formatted message to the feishu webhook if the release fails                                    |

## Installation

```sh
yarn add --dev semantic-release-weapp
```

## Usage

Add the following to your `release.config.js`

```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

| 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](src/get-platform-emoji.js) |
| `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`  | `true`                        | `"fullReleaseNotes": false`          | Provides the full release notes in feishu instead of a link to the release notes                                           |
| `failureMessage`   | `Boolean`  | `false`                       | `"failureMessage": true`             | Sends message when the release failed                                                                                      |

---
_Source: https://npm.io/package/semantic-release-weapp · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._