@serverless-devs/s 2.0.92 → 2.0.93-beta.4

package/CONTRIBUTORS.md

@@ -2,6 +2,8 @@
 
 > Thank you for your support and recognition of serverless devs. Serverless devs is committed to creating an active and open serverless developer ecosystem, providing more simple and easy-to-use serverless developer tools for more serverless developers.
 
+> If you also contributed to this project, but there is no your name below, please add your information at the end in order and submit [Pull Requests](https://github.com/Serverless-Devs/Serverless-Devs/pulls) to us
+
 <center>
     <table>
         <tr>

package/bin/s-component

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('../lib/component');

package/bin/s-set-workspace

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('../lib/set/workspace');

package/docs/readme.md

@@ -0,0 +1,94 @@
+<div align=center> <img src="https://images.devsapp.cn/devs-github/logo.jpg" width="100%"/> </div>
+<br>
+<p align="center">
+  <a href="https://www.npmjs.com/package/@serverless-devs/s">
+    <img src="https://img.shields.io/npm/v/@serverless-devs/s" alt="npm version">
+  </a>
+  <a href="https://www.npmjs.com/package/@serverless-devs/s">
+    <img src="https://img.shields.io/npm/dy/@serverless-devs/s" alt="npm download">
+  </a>
+  <a href="https://nodejs.org/en/">
+    <img src="https://img.shields.io/badge/node-%3E%3D%2010.8.0-brightgreen" alt="node.js version">
+  </a>
+  <a href="https://github.com/Serverless-Devs/Serverless-Devs/blob/master/LICENSE">
+    <img src="https://img.shields.io/badge/License-MIT-green" alt="license">
+  </a>
+  <a href="https://github.com/Serverless-Devs/Serverless-Devs/issues">
+    <img src="https://img.shields.io/github/issues/serverless-devs/serverless-devs" alt="issues">
+  </a>
+  <a href="https://github.com/Serverless-Devs/Serverless-Devs/discussions">
+    <img src="https://img.shields.io/github/discussions/serverless-devs/serverless-devs" alt="discussions">
+  </a>
+</p>
+
+<p align="center">
+  <span><b>Serverless 应用全生命周期管理工具</b></span><br>
+</p>
+
+**Serverless Devs** 是一个开源开放的 Serverless 开发者平台，致力于为开发者提供强大的工具链体系。通过该平台，开发者不仅可以一键体验多云 Serverless 产品，极速部署 Serverless 项目，还可以在 Serverless 应用全生命周期进行项目的管理，并且非常简单快速的将 Serverless Devs 与其他工具/平台进行结合，进一步提升研发、运维效能。
+
+![图片alt](https://serverless-article-picture.oss-cn-hangzhou.aliyuncs.com/1635319587379_20211027072627561648.png)
+
+> 更多关于 Serverless Devs 的介绍可以参考[项目介绍文档](./zh/readme.md)
+
+# 快速上手
+
+❶ 安装 Node.js(>=10.8.0) 与 NPM 包管理工具；   
+❷ 安装 Serverless Devs 开发者工具；   
+```shell script
+$ npm install @serverless-devs/s -g
+```
+❸ 在命令行中执行命令`s`，并按回车，开启你的 Serverless 之旅；   
+
+> 更多详细信息可以参考[Serverless Devs 安装文档](./zh/install.md)和[快速入门指南](./zh/quick_start.md)
+
+# 帮助文档
+
+- [安装文档](zh/install.md)
+- [命令行操作](zh/command/readme.md)
+- [Yaml规范](zh/yaml.md)
+- [CI/CD平台集成](zh/cicd.md)
+
+> 如果您想为 Serverless Devs 贡献 Package（包括组件和应用），您可以参考 [Package开发文档](zh/package_dev.md)  
+
+> Serverless Devs 天然支持 Yaml 模式与 Cli 模式，关于两者的区别和试用场景，可以参考文档[ Yaml 模式 Cli 模式对比](./../yaml_and_cli.md)
+
+# 相关资源
+
+目前 Serverless Devs 项目已经支持的 FaaS 平台/产品：
+
+- 阿里云函数计算（FC）: [项目仓库](https://github.com/devsapp/fc)
+- AWS Lambda: [项目仓库](https://github.com/devscomp/lambda)
+- 百度智能云函数计算（CFC）: [项目仓库](https://github.com/xinwuyun/cfc)
+- 华为云函数工作流（FG）: [项目仓库](https://github.com/xinwuyun/fg)
+- 腾讯云云函数（SCF）: [项目仓库](https://github.com/devscomp/scf)
+
+> 尽管以上 FaaS 平台/产品已经有人贡献或在持续维护中，但是我们仍然非常欢迎大家可以参与贡献/维护，除此之外，其他的 FaaS 平台/产品（例如 Google Cloud Platform Functions、Azure Functions等），我们也非常期望社区的小伙伴们可以参与开发和贡献。
+
+> 🚀 除此之外 Serverless Devs 项目还拥有很多优秀的组件和应用，可以参考[Awesome](./zh/awesome.md)
+
+# 项目贡献
+
+我们非常希望您可以和我们一起贡献这个项目。贡献内容包括不限于代码的维护、应用/组件的贡献、文档的完善等，更多详情可以参考[ 🏆 贡献指南](../CONTRIBUTING.md)。
+
+与此同时，我们也非常感谢所有[ 👬 参与贡献的小伙伴](../CONTRIBUTORS.md)，为 Serverless Devs 项目贡献的努力和汗水。
+
+# 开源许可
+
+Serverless Devs 遵循 [MIT License](../LICENSE) 开源许可。
+
+位于`node_modules`和外部目录中的所有文件都是本软件使用的外部维护库，具有自己的许可证；我们建议您阅读它们，因为它们的条款可能与[MIT License](../LICENSE)的条款不同。
+
+# 交流社区
+
+<p align="center">
+
+| <img src="https://serverless-article-picture.oss-cn-hangzhou.aliyuncs.com/1635407298906_20211028074819117230.png" width="200px" > | <img src="https://serverless-article-picture.oss-cn-hangzhou.aliyuncs.com/1635407044136_20211028074404326599.png" width="200px" > | <img src="https://serverless-article-picture.oss-cn-hangzhou.aliyuncs.com/1635407252200_20211028074732517533.png" width="200px" > |
+|--- | --- | --- |
+| <center>关注微信公众号：`serverless`</center> | <center>联系微信小助手：`xiaojiangwh`</center> | <center>加入钉钉交流群：`33947367`</center> | 
+
+</p>
+
+-----------
+
+> Serverless Devs 开发者工具遵循 [Serverless Devs Model](../spec/readme.md)，更多模型/规范信息可以参考 [Serverless Registry Model](../spec/zh/0.0.1/serverless_registry_model/readme.md)，[Serverless User Model](../spec/zh/0.0.1/serverless_user_model/readme.md) 以及 [Serverless Package Model](../spec/zh/0.0.1/serverless_pacakge_model/readme.md)；另外，关于项目设计的一些细节可以参考[开发者工具设计文档](./zh/tool.md)

package/docs/zh/awesome.md

@@ -0,0 +1,296 @@
+# Package Awesome
+
+- [应用集合](#应用集合)
+- [组件集合](#组件集合)
+
+
+# 应用集合
+
+## Web Framework应用案例
+
+<table>
+<tr>
+<th>No.</th>
+<th>:fire:Nodejs</th>
+<th>Python</th>
+<th>PHP</th>
+<th>Go</th>
+<th>Java</th>
+<th>Others</th>
+</tr>
+<tr>
+<td align="center">1</td>
+<td align="center">:fire:<a href="https://github.com/devsapp/start-express">Express</a></td>
+<td align="center">:fire::fire:<a href="https://github.com/devsapp/start-flask">Flask</a></td>
+<td align="center"><a href="https://github.com/devsapp/start-thinkphp">Think PHP</a></td>
+<td align="center">BeeGo</td>
+<td align="center">Tomcat/Jetty</td>
+<td align="center">Gatsby</td>
+</tr>
+<tr>
+<td align="center">2</td>
+<td align="center"><a href="https://github.com/devsapp/start-egg">Egg</a></td>
+<td align="center"><a href="https://github.com/devsapp/start-tornado">Tornado</a></td>
+<td align="center"><a href="https://github.com/devsapp/start-laravel">laravel</a></td>
+<td align="center">Gin</td>
+    <td align="center"><a href="https://github.com/devsapp/start-springboot">Spring Boot</a></td><td>Hugo</td>
+</tr>
+<tr>
+<td align="center">3</td>
+<td align="center"><a href="https://github.com/devsapp/start-next">Nextjs</a></td>
+<td align="center"><a href="https://github.com/devsapp/start-bottle">Bottle</a></td>
+    <td align="center"><a href="https://github.com/devsapp/start-discuz">Discuz</a></td><td></td><td align="center">Quarkus</td>
+<td align="center"></td>
+</tr>
+<tr>
+<td align="center">4</td>
+<td align="center"><a href="https://github.com/devsapp/start-nuxt">Nuxtjs(Container)</a><br><a href="https://github.com/devsapp/custom-nuxt">Nuxtjs(Custom)</a></td>
+<td align="center"><a href="https://github.com/devsapp/start-webpy">Web.py</a></td>
+<td align="center"> :fire::fire::fire: <a href="https://github.com/devsapp/start-wordpress" >WordPress</a></td><td></td><td></td>
+<td align="center"></td>
+</tr>
+<tr>
+<td align="center">5</td>
+<td align="center"> :fire::fire::fire: <a href="https://github.com/devsapp/start-hexo" >Hexo</a></td>
+<td align="center"><a href="https://github.com/devsapp/start-django" >Django</a></td>
+<td align="center"> :fire::fire::fire: <a href="https://github.com/devsapp/start-zblog" >Zblog</a></td><td></td><td></td>
+<td align="center"></td>
+</tr>
+<tr>
+<td align="center">6</td>
+<td align="center"><a href="https://github.com/devsapp/start-koa">Koa(Container)</a><br><a href="https://github.com/devsapp/nodejs-koa">Koa(Node.js Runtime)</a></td>
+    <td align="center">FastAPI</td>
+<td align="center"><a href="https://github.com/devsapp/start-ecshop" >Ecshop</a></td><td></td><td></td><td></td>
+</tr>
+<tr>
+<td align="center">7</td>
+<td align="center"><a href="https://github.com/devsapp/start-hapi" >Hapi</a></td>
+<td align="center">Web2py</td>
+<td align="center"><a href="https://github.com/devsapp/start-metinfo" >Metinfo</a></td>
+    <td></td><td></td><td></td>
+</tr>
+<tr>
+<td align="center">8</td>
+    <td align="center"><a href="https://github.com/devsapp/start-expresscart">Expresscart</a></td>
+<td align="center"><a href="https://github.com/devsapp/start-pyramid" >Pyramid</a></td>
+<td align="center"><a href="https://github.com/devsapp/start-whatsns" >Whatsns</a></td><td></td><td></td><td></td>
+</tr>
+<tr>
+<td align="center">9</td>
+ <td align="center"></td>
+<td align="center"></td>
+<td align="center"><a href="https://github.com/devsapp/start-typecho" >Typecho</a></td><td></td><td></td><td></td>
+</tr>
+</table>
+
+## 静态网站应用案例
+
+静态网站案例：https://github.com/devsapp/website-example
+- 普通静态资源应用: `s init devsapp/website-example:website-base`
+- react应用 `s init devsapp/website-example:website-react`
+- vue应用 `s init devsapp/website-example:website-vue`
+- hexo应用 `s init devsapp/website-example:website-hexo`
+- docusaurus应用 `s init devsapp/website-example:website-docusaurus`
+- vuepress应用 `s init devsapp/website-example:website-vuepress`
+
+## 开源框架应用案例
+- Midway FaaS：https://github.com/devsapp/midway-hook-example
+    - react模板: `s init devsapp/midway-hook-example:midway-hook-react`
+    - vue模板 `s init devsapp/midway-hook-example:midway-hook-vue`
+- Malagu：https://github.com/devsapp/start-s-malagu
+
+## 场景合集
+
+### Blog集合
+- Zblog:  https://github.com/devsapp/start-zblog    `s init devsapp/start-zblog`
+- Wordpress:  https://github.com/devsapp/start-wordpress    `s init devsapp/start-wordpress`
+- Hexo:  https://github.com/devsapp/start-hexo    `s init devsapp/start-hexo`
+- Vuepress:  https://github.com/devsapp/website-example    `s init devsapp/website-example:website-vuepress`
+- Django Blog: https://github.com/devsapp/django-blog    `s init devsapp/django-zblog` 
+- Typecho: https://github.com/devsapp/start-typecho    `s init devsapp/start-typecho` 
+
+### 企业官网
+- Metinfo: https://github.com/devsapp/start-metinfo   `s init devsapp/start-metinfo`
+
+### 社区问答
+- Whatsns: https://github.com/devsapp/start-whatsns   `s init devsapp/start-whatsns`
+- Discuz: https://github.com/devsapp/start-discuz   `s init devsapp/start-discuz`
+
+### 电子商务
+- Echsop： https://github.com/devsapp/start-ecshop    `s init devsapp/start-ecshop`
+- Expresscart： https://github.com/devsapp/start-expresscart    `s init devsapp/start-expresscart`
+
+### 其他
+- 该项目模板是一个基于 puppeteer 的截图 Web 应用: 
+    - https://github.com/devsapp/puppeteer-app    `s init devsapp/puppeteer-app`
+    - https://github.com/devsapp/start-puppeteer    `s init devsapp/start-puppeteer`
+- 一款基于人工智能的目标检测应用: https://github.com/devsapp/image-prediction-app    `s init devsapp/image-prediction-app`
+- 一款基于Node.JS的网页TodoList应用: https://github.com/devsapp/todolist-app    `s init devsapp/todolist-app`
+- 基于函数计算 FC + FFmpeg 实现 Serverless 架构的弹性高可用的高度自定义音视频处理主题: https://github.com/devsapp/ffmpeg-app    `s init devsapp/ffmpeg-app`
+- 对直播视频流截图的应用: https://github.com/devsapp/start-rtmp-snapshot   `s init start-rtmp-snapshot`
+- 一个对浏览器全景录制: https://github.com/devsapp/start-headless-ffmpeg   `s init start-headless-ffmpeg`
+- 一个word转pdf的应用: https://github.com/devsapp/start-word2pdf   `s init start-word2pdf`
+- 一个pdf转图片的应用: https://github.com/devsapp/start-pdf2img   `s init start-pdf2img`
+- 在Serverless架构玩转pyTorch: https://github.com/devsapp/start-pytorch   `s init start-pytorch`
+- 在Serverless架构玩转Tensorflow: https://github.com/devsapp/start-tensorflow   `s init start-tensorflow`
+- Serverless架构的OCR工具: https://github.com/devsapp/start-ocr   `s init start-ocr`
+
+
+## 静态网站应用案例
+
+静态网站案例：https://github.com/devsapp/website-example
+- 普通静态资源应用: `s init devsapp/website-example:website-base`
+- react应用 `s init devsapp/website-example:website-react`
+- vue应用 `s init devsapp/website-example:website-vue`
+- hexo应用 `s init devsapp/website-example:website-hexo`
+- docusaurus应用 `s init devsapp/website-example:website-docusaurus`
+- vuepress应用 `s init devsapp/website-example:website-vuepress`
+
+## Alinode
+可观测性：
+    - Insight： https://github.com/devsapp/alinode-faas-insight    
+    - Runtime Http:  https://github.com/devsapp/alinode-runtime-http    
+    - FaaS Logs:  https://github.com/devsapp/alinode-faas-sls-log    
+    - Runtime Deploy:  https://github.com/devsapp/alinode-runtime-deploy
+
+## 开源框架应用案例
+- Midway FaaS：https://github.com/devsapp/midway-hook-example
+    - react模板: `s init devsapp/midway-hook-example:midway-hook-react`
+    - vue模板 `s init devsapp/midway-hook-example:midway-hook-vue`
+- Malagu：https://github.com/devsapp/start-s-malagu
+
+## 场景合集
+
+### Blog集合
+- Zblog:  https://github.com/devsapp/start-zblog    `s init devsapp/start-zblog`
+- Wordpress:  https://github.com/devsapp/start-wordpress    `s init devsapp/start-wordpress`
+- Hexo:  https://github.com/devsapp/start-hexo    `s init devsapp/start-hexo`
+- Vuepress:  https://github.com/devsapp/website-example    `s init devsapp/website-example:website-vuepress`
+- Django Blog: https://github.com/devsapp/django-blog    `s init devsapp/django-zblog` 
+- Typecho:  https://github.com/devsapp/start-typecho    `s init devsapp/start-typecho`
+
+### 企业官网
+- Metinfo: https://github.com/devsapp/start-metinfo   `s init devsapp/start-metinfo`
+
+### 社区问答
+- Whatsns: https://github.com/devsapp/start-whatsns   `s init devsapp/start-whatsns`
+- Discuz: https://github.com/devsapp/start-discuz   `s init devsapp/start-discuz`
+
+### 电子商务
+- Echsop： https://github.com/devsapp/start-ecshop    `s init devsapp/start-ecshop`
+- Expresscart： https://github.com/devsapp/start-expresscart    `s init devsapp/start-expresscart`
+
+### 其他
+- 该项目模板是一个基于 puppeteer 的截图 Web 应用: 
+    - https://github.com/devsapp/puppeteer-app    `s init devsapp/puppeteer-app`
+    - https://github.com/devsapp/start-puppeteer    `s init devsapp/start-puppeteer`
+- 一款基于人工智能的目标检测应用: https://github.com/devsapp/image-prediction-app    `s init devsapp/image-prediction-app`
+- 一款基于Node.JS的网页TodoList应用: https://github.com/devsapp/todolist-app    `s init devsapp/todolist-app`
+- 基于函数计算 FC + FFmpeg 实现 Serverless 架构的弹性高可用的高度自定义音视频处理主题: https://github.com/devsapp/ffmpeg-app    `s init devsapp/ffmpeg-app`
+- 对直播视频流截图的应用: https://github.com/devsapp/start-rtmp-snapshot   `s init start-rtmp-snapshot`
+- 一个对浏览器全景录制: https://github.com/devsapp/start-headless-ffmpeg   `s init start-headless-ffmpeg`
+- 一个word转pdf的应用: https://github.com/devsapp/start-word2pdf   `s init start-word2pdf`
+- 一个pdf转图片的应用: https://github.com/devsapp/start-pdf2img   `s init start-pdf2img`
+- 在Serverless架构玩转pyTorch: https://github.com/devsapp/start-pytorch   `s init start-pytorch`
+- 在Serverless架构玩转Tensorflow: https://github.com/devsapp/start-tensorflow   `s init start-tensorflow`
+- Serverless架构的OCR工具: https://github.com/devsapp/start-ocr   `s init start-ocr`
+
+
+# 组件集合
+
+## 基础组件
+
+- 阿里云
+    - 函数计算（FC）：
+        - Yaml描述：https://github.com/devsapp/fc
+        - 命令行交互：https://github.com/devsapp/fc-api （可以在无Yaml模式下直接进行使用）
+    - Serverless工作流（FNF）：https://github.com/devsapp/fnf
+- 腾讯云
+    - 云函数（SCF）：https://github.com/devscomp/scf
+- AWS
+    - Lambda：https://github.com/devscomp/lambda
+- 百度云
+    - 函数计算（CFC）：https://github.com/xinwuyun/cfc
+- 华为云
+    - 函数工作流（FG）：https://github.com/xinwuyun/fg
+
+
+
+
+## 上层组件
+
+<table>
+<tr>
+<th>No.</th>
+<th>:fire:Nodejs</th>
+<th>Python</th>
+<th>PHP</th>
+<th>Go</th>
+<th>Java</th>
+<th>Others</th>
+</tr>
+<tr>
+<td align="center">1</td>
+<td align="center">:fire:<a href="https://github.com/devsapp/express">Express</a></td>
+<td align="center">:fire::fire:<a href="https://github.com/devsapp/flask">Flask</a></td>
+<td align="center"><a href="https://github.com/devsapp/thinkphp">Think PHP</a></td>
+<td align="center">BeeGo</td>
+<td align="center">Tomcat/Jetty</td>
+<td align="center">Gatsby</td>
+</tr>
+<tr>
+<td align="center">2</td>
+<td align="center"><a href="https://github.com/devsapp/egg">Egg</a></td>
+<td align="center"><a href="https://github.com/devsapp/tornado">Tornado</a></td>
+<td align="center"><a href="https://github.com/devsapp/laravel">laravel</a></td>
+<td align="center">Gin</td>
+<td align="center">Spring Boot</td>
+<td align="center">Hugo</td>
+</tr>
+<tr>
+<td align="center">3</td>
+<td align="center"><a href="https://github.com/devsapp/next">Nextjs</a></td>
+<td align="center"><a href="https://github.com/devsapp/bottle">Bottle</a></td>
+<td align="center"><a href="https://github.com/devsapp/discuz">Discuz</a></td><td></td><td align="center">Quarkus</td>
+<td align="center">:fire::fire:<a href="https://github.com/devsapp/midway-hook">Midway FaaS</a></td>
+</tr>
+<tr>
+<td align="center">4</td>
+<td align="center"><a href="https://github.com/devsapp/nuxt">Nuxtjs</a></td>
+<td align="center"><a href="https://github.com/devsapp/webpy">Web.py</a></td>
+<td align="center"> :fire::fire::fire: <a href="https://github.com/devsapp/wordpress" >WordPress</a></td><td></td><td></td>
+<td align="center">:fire:<a href="https://github.com/devsapp/s-malagu">Malagu</a></td>
+</tr>
+<tr>
+<td align="center">5</td>
+<td align="center"> :fire::fire::fire: <a href="https://github.com/devsapp/hexo" >Hexo</a></td>
+<td align="center"><a href="https://github.com/devsapp/django" >Django</a></td>
+<td align="center"> :fire::fire::fire: <a href="https://github.com/devsapp/zblog" >Zblog</a></td><td></td><td></td>
+<td align="center">:fire::fire::fire:<a href="https://github.com/devsapp/website">Website</a></td>
+</tr>
+<tr>
+<td align="center">6</td>
+<td align="center"><a href="https://github.com/devsapp/koa" >Koa</a></td>
+<td align="center">FastAPI</td>
+<td align="center"><a href="https://github.com/devsapp/ecshop" >Ecshop</a></td><td></td><td></td><td></td>
+</tr>
+<tr>
+<td align="center">7</td>
+<td align="center"><a href="https://github.com/devsapp/hapi" >Hapi</a></td>
+<td align="center">Web2py</td>
+<td align="center"><a href="https://github.com/devsapp/metinfo" >Metinfo</a></td>
+    <td></td><td></td><td></td>
+</tr>
+<tr>
+<td align="center">8</td>
+<td align="center"></td>
+<td align="center"><a href="https://github.com/devsapp/pyramid" >Pyramid</a></td>
+<td align="center"><a href="https://github.com/devsapp/whatsns" >Whatsns</a></td><td></td><td></td><td></td>
+</tr>
+<tr>
+<td align="center">9</td>
+<td align="center"></td>
+<td align="center"></td>
+<td align="center"><a href="https://github.com/devsapp/typecho" >Typecho</a></td><td></td><td></td><td></td>
+</tr>
+</table>

package/docs/zh/cicd.md

@@ -0,0 +1,200 @@
+# 与 CI/CD 平台/工具集成
+
+- [与 Github Action 的集成](#与-github-action-的集成)
+- [与 Gitee Go 的集成](#与-gitee-go-的集成)
+- [与 Jenkins 的集成](#与-jenkins-的集成)
+- [注意事项](#注意事项)
+
+## 与 Github Action 的集成
+
+在 Github Action 的 Yaml 文件中，可以增加 Serverless Devs 的相关下载、配置以及命令执行相关能力。
+
+例如，在仓库中可以创建该文件`.github/workflows/publish.yml`，文件内容：
+
+```yaml
+name: Serverless Devs Project CI/CD
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  serverless-devs-cd:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 12
+          registry-url: https://registry.npmjs.org/
+      - run: npm install
+      - run: npm install -g @serverless-devs/s
+      - run: s config add --AccountID ${{secrets.AccountID}} --AccessKeyID ${{secrets.AccessKeyID}} --AccessKeySecret ${{secrets.AccessKeySecret}} -a default
+      - run: s deploy
+```
+
+主要包括几个部分的内容：   
+- `run: npm install -g @serverless-devs/s`:    
+    通过NPM安装最新版本的 Serverless Devs 开发者工具；
+- `run: s config add --AccountID ${{secrets.AccountID}} --AccessKeyID ${{secrets.AccessKeyID}} --AccessKeySecret ${{secrets.AccessKeySecret}} -a default`    
+    通过`config`命令进行密钥等信息的配置；
+- `run: s deploy`   
+    执行某些命令，例如通过`deploy`进行项目的部署，或者`build`等命令进行构建等；
+
+关于密钥的配置：密钥信息的获取是通过`${{secrets.*}}`进行获取的，所以此时，需要将所需要的密钥和对应的`Key`配置到 Github Secrets 中，例如在上面的案例中，需要`AccountID`,`AccessKeyID`,`AccessKeySecret`等三个密钥的 Key ，我们就可以配置相关的内容：
+
+1. 将密钥信息配置到Github Secrets中
+    ![](https://user-images.githubusercontent.com/21079031/120761131-71f28080-c547-11eb-9bb8-e08dafabb4ee.png)
+
+2. 我们创建多对密钥信息：
+    ![](https://user-images.githubusercontent.com/21079031/120761249-93ec0300-c547-11eb-9c0d-904fb85b4201.png)
+   例如，我此处配置了三对密钥：
+    ![](https://user-images.githubusercontent.com/21079031/120761347-ae25e100-c547-11eb-9bcd-4fc742671bc5.png)
+
+> 关于密钥配置的部分注意内容，可以参考文末的[注意事项](#注意事项)
+
+## 与 Gitee Go 的集成
+
+在开启 Gitee Go 的服务之后，在流水线的 Yaml 文件中，可以增加 Serverless Devs 的相关下载、配置以及命令执行相关能力。
+
+例如，在仓库中可以创建该文件`.github/workflows/publish.yml`，文件内容：
+
+```yaml
+name: serverless-devs
+displayName: 'Serverless Devs Project CI/CD'
+triggers:                                  # 流水线触发器配置
+  push:                                    # 设置 master 分支 在产生代码 push 时精确触发（PRECISE）构建
+    - matchType: PRECISE
+      branch: master
+commitMessage: ''                          # 通过匹配当前提交的 CommitMessage 决定是否执行流水线
+stages:                                    # 构建阶段配置
+  - stage:                                 # 定义一个 ID 标识为 deploy-stage ,名为「 Deploy Stage 」的阶段
+      name: deploy-stage
+      displayName: 'Deploy Stage'
+      failFast: false                      # 允许快速失败，即当 Stage 中有任务失败时，直接结束整个 Stage
+
+      steps:                               # 构建步骤配置
+        - step: npmbuild@1                 # 采用 npm 编译环境
+          name: deploy-step                # 定义一个 ID 标识为 deploy-step ,名为「 Deploy Step 」的阶段
+          displayName: 'Deploy Step'
+          inputs:                          # 构建输入参数设定
+            nodeVersion: 14.15             # 指定 node 环境版本为 14.15
+            goals: |                       # 安装依赖，配置相关主题、部署参数并发布部署
+              node -v
+              npm -v
+              npm install -g @serverless-devs/s
+              s config add --AccountID $ACCOUNTID --AccessKeyID $ACCESSKEYID --AccessKeySecret $ACCESSKEYSECRET -a default
+              s deploy
+```
+
+主要包括几个部分的内容：   
+- `npm install -g @serverless-devs/s`:    
+    通过NPM安装最新版本的 Serverless Devs 开发者工具；
+- `s config add --AccountID $ACCOUNTID --AccessKeyID $ACCESSKEYID --AccessKeySecret $ACCESSKEYSECRET -a default`    
+    通过`config`命令进行密钥等信息的配置；
+- `s deploy`   
+    执行某些命令，例如通过`deploy`进行项目的部署，或者`build`等命令进行构建等；
+
+关于密钥的配置：密钥信息的获取是通过`$*`进行获取的，所以此时，需要将所需要的密钥和对应的`Key`配置到 Gitee 的环境变量管理即可，例如在上面的案例中，需要`ACCOUNTID`,`ACCESSKEYID`,`ACCESSKEYSECRET`等三个密钥的 Key ，我们就可以配置相关的内容：
+
+1. 找到 Gitee 的环境变量管理
+    ![](https://user-images.githubusercontent.com/21079031/124716639-e5b4ee00-df36-11eb-9dc8-cf2d8eb30e51.png)
+
+2. 我们创建多对密钥信息：
+    ![](https://user-images.githubusercontent.com/21079031/124719394-aa67ee80-df39-11eb-84ad-944ccf0486ba.png)
+   例如，我此处配置了三对密钥：
+    ![](https://user-images.githubusercontent.com/21079031/124719496-c9ff1700-df39-11eb-8ef6-4ccae28caefc.png)
+
+> 关于密钥配置的部分注意内容，可以参考文末的[注意事项](#注意事项)
+
+
+## 与 Jenkins 的集成
+
+在准备将 Serverless Devs 集成到 Jenkins 之前，需要先基于 [Jenkins 官网](https://www.jenkins.io/zh/doc/pipeline/tour/getting-started/) 安装并运行 Jenkins。
+
+本地启动 Jenkins 后，通过浏览器进入链接 `http://localhost:8080` 配置完成基础设置后，需要新增 Credentials 设置，如下图所示：
+
+![](https://img.alicdn.com/imgextra/i2/O1CN01tSgoo71Ne62AMGxqh_!!6000000001594-2-tps-3582-1048.png)
+
+此时可以根据需要，增加密钥信息，以阿里云为例，新增三个全局凭据：
+
+```
+jenkins-alicloud-account-id : 阿里云 accountId
+
+jenkins-alicloud-access-key-id : 阿里云 accessKeyId
+
+jenkins-alicloud-access-key-secret : 阿里云 accessKeySecret
+```
+
+> 新增 Credentials 的教程可以参考[这里](https://www.jenkins.io/zh/doc/book/using/using-credentials/)。
+
+此时，可以对自身的 Serverless Devs 项目进行完善：
+
+- 创建文件`Jenkinsfile`
+    ```
+    pipeline {
+        agent {
+            docker {
+                image 'maven:3.3-jdk-8'
+            }
+        }
+    
+        environment {
+            ALICLOUD_ACCESS = 'default'
+            ALICLOUD_ACCOUNT_ID     = credentials('jenkins-alicloud-account-id')
+            ALICLOUD_ACCESS_KEY_ID     = credentials('jenkins-alicloud-access-key-id')
+            ALICLOUD_ACCESS_KEY_SECRET     = credentials('jenkins-alicloud-access-key-secret')
+        }
+    
+        stages {
+            stage('Setup') {
+                steps {
+                    sh 'scripts/setup.sh'
+                }
+            }
+        }
+    }
+    ```
+    主要的内容包括两个部分：
+    - environment 部分，主要是根据上面步骤配置的密钥信息，进行密钥的处理；
+    - stages 部分，这里面会有一个部分是`sh 'scripts/setup.sh'`，即运行`scripts/setup.sh`文件，进行相关内容的准备和配置；
+- 准备`scripts/setup.sh`文件，只需要在项目下，创建该文件即可：
+    ```shell script
+    #!/usr/bin/env bash
+    
+    echo $(pwd)
+    curl -o- -L http://cli.so/install.sh | bash
+    
+    source ~/.bashrc
+    
+    echo $ALICLOUD_ACCOUNT_ID
+    s config add --AccountID $ALICLOUD_ACCOUNT_ID --AccessKeyID $ALICLOUD_ACCESS_KEY_ID --AccessKeySecret $ALICLOUD_ACCESS_KEY_SECRET -a $ALICLOUD_ACCESS
+    
+    (cd code && mvn package && echo $(pwd))
+    
+    s deploy -y --use-local --access $ALICLOUD_ACCESS
+    ```
+    在该文件中，主要包括了几个部分：
+    - `curl -o- -L http://cli.so/install.sh | bash`    
+        下载并安装 Serverless Devs 开发者工具
+    - `s config add --AccountID $ALICLOUD_ACCOUNT_ID --AccessKeyID $ALICLOUD_ACCESS_KEY_ID --AccessKeySecret $ALICLOUD_ACCESS_KEY_SECRET -a $ALICLOUD_ACCESS`    
+        配置密钥信息等内容
+    - `s deploy -y --use-local --access $ALICLOUD_ACCESS`   
+        执行某些命令，例如通过`deploy`进行项目的部署，或者`build`等命令进行构建等；
+    
+    
+完成密钥配置之后，可以创建一个 Jenkins 流水线，该流水线的源是目标 github 地址。接下来，就可以开始运行 Jenkins 流水线，运行结束后，就可以得到相关的内容结果。
+
+> 关于密钥配置的部分注意内容，可以参考文末的[注意事项](#注意事项)
+
+
+## 注意事项
+
+- 在配置密钥的时候，使用了`s config add`命令，此时在最后有一个参数是`-a default`，代表的是给该密钥一个叫`default`的别名，这个别名要和项目所设定的使用密钥保持一致，例如在`s.yaml`中的`access`字段；
+- 如果在当前应用在，涉及到了配置部署到不同的平台或者账号下，可能会涉及到配置多个密钥信息，此时需要给不同的密钥不同的别名，并且在`s.yaml`中进行使用；
+- 如果想要配置更为灵活的密钥信息，可以考虑通过`-il`和`-kl`参数获取，例如同时配置两对密钥，并且使用自定义 Key ：
+  ```yaml
+  s config add -kl tempToken1,tempToken2 -il tempValue1,tempValue2 -a website_access
+  s config add -kl tempToken3,tempToken4 -il tempValue3,tempValue4 -a fc_access
+  ```
+