cgq001 / serverless-tencent

⚡️ 🐧 Serverless Tencent CLI 及中文讨论社区

serverless-tencent

🇨🇳 中文网站 • 📖 帮助文档 • 💬 讨论区 • 🐞 BUG反馈 • 👩‍💻👨‍💻 招聘职位

此插件提供了 Serverless 在腾讯云上进行开发和调试的相关功能，并优化了使用流程和体验。

目录

• 快速开始
• 示例
• 支持的命令
• 功能特点
• 贡献代码

快速开始

前置条件

1. Nodejs 12.x 及以上版本
2. Serverless CLI v3.0+, 如果没有安装可以使用 npm i -g serverless 命令安装
3. 注册腾讯云账号并开通相关权限

安装使用

直接使用 serverless-tencent CLI

$ npm i -g serverless-tencent
$ slt init express-starter --name example
$ cd example
$ slt deploy

Serverless Framework CLI 集成使用

$ npm i -g serverless
$ sls init express-starter --name example
$ cd example
$ sls deploy

支持的命令

• Init 创建
• Deploy 部署
• Info 详情
• Dev 远程开发
• Logs 日志
• Remove 移除
• Credentials 授权
• Registry 注册中心
• Invoke 远程调用
• Invoke Local 本地调用

功能特点

• 支持 Node.js, Python, Java, Go, Php, , 也可以使用自定义运行环境
• 可以通过serverless-tencent CLI管理你的 serverless 项目的整个生命周期:
  • 部署: sls deploy
  • 调用: sls invoke
  • 本地调用: sls invoke local, 当前支持Node.js, Python, Php 项目
  • 日志查看: sls logs
  • 实例信息查看: sls info
  • 实例删除: sls remove
  • 实时调试: sls dev
• 丰富的官方组件支持, 下面所列出仅为一部分
  • scf
  • http
  • multi-scf
  • website
  • DiscusQ
• 对不同组件的配置文件字段进行校验, 包括字段类型，字段值的范围，字段可取限制等，为用户提供更友好的开发体验和错误排查。 当前支持对scf, multi-scf, http, website组件的配置文件进行校验

贡献代码

serverless-tencent 是一个包容友好的开源项目，欢迎不同的代码贡献者

单元测试补充

1. 我们的单元测试代码位于 tests/ 目录之下，使用jest 作为测试工具，npm run test 运行所有的单元测试
2. 您需要为你提交的功能代码补充对应的单元测试, 并且不可以破坏已有的其他模版对应的单元测试。 这是我们保证serverless-tencent 代码健壮性的基本条件

Canary 测试版本

提交代码到 master 分支，合并之后会自动发布项目的 canary 版本，可以通过 npm i -g serverless-tencent@canary 安装测试

发布正式版本

1. 功能完成之后，需要修改 package.json/version 字段以及在 CHANGELOG.md 中写明更新日志
2. 提交代码到 master, 合并之后自动发布正式版本