在前端开发中，时常需要将代码发布到线上服务器，并通知整个团队或者客户。一个高效的通知方式是通过 SNS（Simple Notification Service）服务。本文将介绍一个 npm 包 release-sns，它可以在代码发布时自动发送通知邮件或短信。
安装
npm install release-sns --save-dev
配置
AWS 配置
由于 release-sns 是基于 AWS 的 SNS 服务，所以需要配置 AWS 的密钥和区域。
const ReleaseSNS = require('release-sns');
ReleaseSNS.config({
accessKeyId: 'YOUR_AWS_ACCESS_KEY',
secretAccessKey: 'YOUR_AWS_ACCESS_SECRET',
region: 'YOUR_AWS_REGION'
})ReleaseSNS 配置
在代码发布前，需要在 release-sns 中配置通知的主题、接收邮件地址以及接收短信电话号码。
-- -------------------- ---- ------- ----- ---------- - ----------------------- ----- ---------- - --- ------------ ------ --------------------- ------ -------------- --------- --------------------- ------------ ----- ------- ----- --- -------------------- -- - ------------------ ---------- --
通知主题可以在 AWS SNS 服务中创建。topicArn 可以通过 SNS 控制台获取。
使用
在项目的 package.json 中，可以配置自定义的脚本。
{
"scripts": {
"release": "release-sns"
}
}在发布时，运行命令：
npm run release
在代码发布后，收件人将会收到邮件和短信。
示例代码
假设一个项目有以下的 package.json 文件：
{
"name": "your-project",
"version": "1.0.0",
"scripts": {
"release": "release-sns"
}
}在运行发布命令之前，修改 index.js 文件，让它输出一行日志：
console.log('release');然后，运行发布命令：
npm run release
通过 AWS 控制台可以看到 SNS 已经发送了邮件和短信通知。
总结
release-sns 是一个自动化发布通知的 npm 包，它可以让我们更快地通知整个团队或客户。使用时需要在 AWS 控制台中创建 SNS 主题，并设置 accessKeyId，secretAccessKey 和 region。在代码中，需要配置通知的主题、接收邮件地址和短信电话号码。通过设定自定义脚本并运行 npm run release 命令，发布时便能自动发送通知邮件和短信。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600556e681e8991b448d3c4d