@serverless-devs/s 2.0.95 → 2.0.97-beta.11

package/docs/zh/cicd.md

@@ -1,231 +0,0 @@
-# 与 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 流水线，运行结束后，就可以得到相关的内容结果。
-
-> 关于密钥配置的部分注意内容，可以参考文末的[注意事项](#注意事项)
-
-
-## 与云效的集成
-
-在云效中，可以直接选择Serverless Devs开发者工具，并在自定义命令中，输入以下内容即可：
-
-```
-# input your command here
-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 开发者工具（虽然云效中已经拥有了相关版本的Serverless Devs，但是实际上，这个版本可能比较老旧，所以可以通过该命令安装最新版本）；
-- `s config add --AccountID ${ACCOUNTID} --AccessKeyID ${ACCESSKEYID} --AccessKeySecret ${ACCESSKEYSECRET} -a default`    
-    通过`config`命令进行密钥等信息的配置；
-- `s deploy`   
-    执行某些命令，例如通过`deploy`进行项目的部署，或者`build`等命令进行构建等；
-
-效果如下：
-
-![image](https://user-images.githubusercontent.com/21079031/144697943-2ce9ea56-7af8-4c3b-945b-6897e6d744b5.png)
-
-由于在命令中，引用了三个重要的环境变量：`ACCOUNTID`, `ACCESSKEYID`, `ACCESSKEYSECRET`，所以还需要在环境变量中，增加类似的内容：
-
-![image](https://user-images.githubusercontent.com/21079031/144699074-3dad63d7-835f-4eb8-bd95-662de683dbbc.png)
-
-
-
-## 注意事项
-
-- 在配置密钥的时候，使用了`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
-  ```
-  

package/docs/zh/cli_design.md

@@ -1,100 +0,0 @@
-# 命令行设计规范
-
-Serverless Devs 作为 Serverless 领域的开发者工具，其输出的标准化和规范化会在一定程度上对用户体验有比较明显的影响。
-
-本文档将会通过一些文字和案例，对Serverless Devs的命令行工具输出，进行规范化升级。
-
-## 规范详情
-
-输出格式的规范目标是：
-
-- 更清晰
-- 更简约
-- 不影响功能实用
-
-基于以上三个原则，我们可以通过正常输出的形式、异常输出的形式等分别进行举例说明
-
-### 基本输出
-
-基本输出的形式，整体上包括两个部分：
-
-1. 项目执行阶段
-
-项目执行阶段主要包括一个基本格式:
-
-```
-⌛ Steps for process
-====================
-```
-
-采用重写机制，不断的更新输出内容，每个项目执行完成可以输出相对应的结果，示例：
-
-```
-⌛ Steps for process
-====================
-✔ Pre-action completed (10s)
-```
-
-2. 结果输出阶段
-
-项目执行阶段主要包括一个基本格式:
-
-```
-🚀 Result for process
-====================
-```
-
-具体的项目输出采用`Yaml`的格式进行输出，输出时，项目名称要加下划线，如果没有输出则直接结束项目，示例：
-
-```
-🚀 Result for process
-====================
-✔ MyProject deployed (11s)
-fc-deploy-test:
-  region: cn-hangzhou
-  service:
-    name: fc-deploy-service
-    memorySize: 128
-```
-
-#### 单项目输出示例
-
-![render1629447409205](https://user-images.githubusercontent.com/21079031/130204631-174a5af5-5550-4e7f-bc3b-d6d23681ce61.gif)
-
-
-#### 多项目输出示例
-
-![render1629448703505](https://user-images.githubusercontent.com/21079031/130206222-8674550e-2ecf-4e19-9dac-d81a8ab11b02.gif)
-
-
-### 调试模式
-
-当用户使用`--debug`进入到调试模式，则会打印非常详细的信息在控制台，但是这些信息将会以灰色形式打印出来，以保持整体的层次感：
-
-![render1629448900851](https://user-images.githubusercontent.com/21079031/130206327-b25c444f-d336-4dc3-8dfe-39a5329e4b13.gif)
-
-
-
-### 错误输出
-
-当执行出现错误时，Serverless Devs要做到感知并输出相对应的内容：
-
-```
-⌛ Steps for process
-====================
-✔ MyProject pre-action completed (10s)
-✖ MyProject failed to deploy:
-
-Error Message: 
-t[r] is not a function
-
-Env:   darwin, node v15.14.0
-Docs:  https://github.com/serverless-devs/docs
-Bugs:  https://github.com/Serverless-Devs/Serverless-Devs/issues
-Logs:  ~/demo/demo/demo/s.log
-```
-
-动态效果为：
-
-![render1629447327225](https://user-images.githubusercontent.com/21079031/130204744-be670d4b-0c1a-4128-aafe-3e8871b3ef58.gif)
-

package/docs/zh/command/clean.md

@@ -1,63 +0,0 @@
-# Clean 命令
-
-`clean`命令是清理 Serverless Devs 的缓存相关功能，可以通过该命令清理环境、不用的依赖包以及相关的缓存内容。
-
-- [命令解析](#命令解析)
-    - [参数解析](#参数解析)
-    - [操作案例](#操作案例)
-    
-## 命令解析
-
-当我们执行`s clean -h`之后，可以进行相关帮助信息的查看：
-
-```shell script
-$ s clean -h
-Usage: s cli [options]
-
-Clean up the cache related functions of serverless devs. You can clean up the environment, unused dependent packages and related cache contents through this command.
-    
-    Example:
-        $ s clean --component fc-api
-        $ s clean --all
-
-    Tips:
-        Get all installed component: s component
-
-📖 Document: https://github.com/Serverless-Devs/Serverless-Devs/tree/master/docs/zh/command/clean.md
-
-Options:
-  --all                         Clean up the environment
-  --cache [dirName]             Delete the <dirName> file in the cache
-  --component [componentName]   Remove component (like: fc, fc@0.0.1)
-  -h, --help                    Display help for command
-```
-
-### 参数解析
-
-| 参数全称 | 参数缩写 | 是否必填 | 参数含义 |
-|-----|-----|-----|-----|
-| all |  | 选填 | 清理环境 |
-| cache |  | 选填 | 删除缓存里的的<dirName>文件 |
-| component |  | 选填 | 删除指定的组件，可以是组件名，也可以是[组件名@版本号] |
-
-### 操作案例
-
-如果想要清理掉某个组件，可以通过`--component`参数与具体的组件名进行清理，例如：
-
-```shell script
-$ s clean --component fc-api
-Component [fc-api] has been cleaned up successfully.
-```
-
-如果想要清理整体环境，可以直接通过`--all`参数进行，例如：
-
-```shell script
-$ s clean --all       
-The environment of Serverless Devs has been cleaned up successfully.
-```
-
-## 注意事项
-
-在进行指定组件的清理时，系统会按照指定的逻辑进行组件的清理：
-1. 系统先会确定当前设置的 Registry 缓存中，存在的符合条件的组件，并进行清理；
-2. 系统将会对系统的最终 Registry 缓存中（Github Registry），存在的符合条件的组件，并进行清理；

package/docs/zh/command/cli.md

@@ -1,92 +0,0 @@
-# Cli 命令
-
-`cli`命令是去Yaml化的命令行模式，即可以通过命令行直接使用 Serverless Devs 的组件，而不需要依赖Yaml文件。
-
-- [命令解析](#命令解析)
-- [常见模式](#常见模式)
-    - [通用组件的支持](#通用组件的支持)
-    - [特定组件的支持](#特定组件的支持)
-
-> Yaml 模式与 Cli 模式的区别和试用场景，可以参考文档[Yaml 模式 Cli 模式对比](./../yaml_and_cli.md)
-
-## 命令解析
-
-当我们执行`s cli -h`之后，可以进行相关帮助信息的查看：
-
-```shell script
-$ s cli -h
-Usage: s cli [component] [method] [options]
-
-Directly use serverless devs to use components, develop and manage applications without yaml configuration.
-    
-    Example:
-        $ s cli fc-api listServices
-        $ s cli fc-api listFunctions --service-name my-service
-        $ s cli fc-api deploy -p "{/"function/": /"function-name/"}"
-    
-📖 Document: https://github.com/Serverless-Devs/Serverless-Devs/tree/master/docs/zh/command/cli.md
-
-Options:
-  -a, --access [aliasName]  Specify the access alias name
-  -p, --props [jsonString]  The json string of props
-  -h, --help                Display help for command
-```
-
-使用方法主要是：
-
-```shell script
-s cli [组件名称，例如fc，fc-api等] [组件的方法] -p/--props [该方法对应的Yaml属性（JSON字符串）] -a/--access [指定密钥信息] [其他设定]
-```
-
-
-## 常见模式
-
-### 通用组件的支持
-
-在`cli`模式下，可以通过`-p, --props [jsonString]`参数对组件进行通用的支持。
-
-例如，某Serverless Devs应用可以通过以下`s.yaml`描述：
-
-```yaml
-edition: 1.0.0
-access: "myaccess"
-
-services:
-  website-starter:
-    component: devsapp/website
-    props:
-      bucket: testbucket
-      src:
-        codeUri: ./
-        publishDir: ./build
-        index: index.html
-      region: cn-hangzhou
-      hosts:
-        - host: auto
-```
-
-并且，可以通过`s website-starter deploy`，将`website-starter`部分进行部署。
-
-此时，如果通过`cli`模式进行部署，可以不需要依赖上述Yaml，但是需要在命令行中，写上完整的参数信息：
-
-```shell script
-s cli devsapp/website deploy -p "{\"bucket\":\"testbucket\",\"src\":{\"codeUri\":\"./\",\"publishDir\":\"./build\",\"index\":\"index.html\"},\"region\":\"cn-hangzhou\",\"hosts\":[{\"host\":\"auto\"}]}" -a myaccess
-```
-
-### 特定组件的支持
-
-在 Serverless Devs 目前已经存在的组件中，已经有一些比较优秀且针对 Cli 模式设计的组件，例如`fc-api`组件，就是一款命令行模式优先的组件，通过该组件，可以快速的使用阿里云函数计算的一些接口，进行操作，例如：
-
-- 查看阿里云函数计算的某个地区下某个服务下的函数列表：
-    ```shell script
-    s cli fc-api listFunctions --service-name my-service --region cn-beijing -a myaccess
-    ```
-- 通过纯命令行形式，对函数进行代码更新：
-    ```shell script
-    s cli fc-api updateFunction --region cn-hangzhou --serviceName fc-deploy-service --functionName http-trigger-function --code '{"zipFile":"./"}'
-    ```
-
-除此之外，很多组件可以即对 Yaml 模式有比较好的支持，也会在某些情况下对 纯命令行模式，进行额外优化设计，例如 `fc` 组件的线上线下资源同步操作：
-```shell script
-s cli fc sync --region cn-shanghai --service-name myService --type config
-```

package/docs/zh/command/component.md

@@ -1,76 +0,0 @@
-# Component 命令
-
-`component`命令是获取已经安装的组件详情信息。
-
-- [命令解析](#命令解析)
-    - [参数解析](#参数解析)
-    - [操作案例](#操作案例)
-- [注意事项](#注意事项)
-
-## 命令解析
-
-当我们执行`s component -h`之后，可以进行相关帮助信息的查看：
-
-```shell script
-$ s component -h
-Usage: s component [options]
-
-Get details of installed components.
-    
-    Example:
-        $ s component
-        $ s component --component fc-api
-
-📖 Document: https://github.com/Serverless-Devs/Serverless-Devs/tree/master/docs/zh/command/component.md
-
-Options:
-  --component [componentName]     Gets the specified component information (like: fc, fc@0.0.1)
-  -h, --help                      Display help for command
-```
-
-### 参数解析
-
-| 参数全称 | 参数缩写 | 是否必填 | 参数含义 |
-|-----|-----|-----|-----|
-| name |  | 选填 | 获取指定的组件信息，可以是组件名，也可以是[组件名@版本号] |
-
-### 操作案例
-
-如果想要获取某个组件，可以通过`--component`参数与具体的组件名进行清理，例如：
-
-```shell script
-$ s component --component fc-api
-Component: fc
-Reigstry: serverless registry [http://registry.devsapp.cn/simple] 
-Version: 0.1.27  
-Size: 100 MB
-Description: 阿里云函数计算基础组件
-Path: ~/.s/components/fc
-Hompage: https://github.com/devsapp/fc
-
-🙋 Delete the component, please use the command [s clean --component fc@0.1.27]
-```
-
-如果想要获取所有已经安装的组件信息，可以直接执行`s component`获取，例如：
-
-```shell script
-$ s component 
-
-🔎 serverless registry [http://registry.devsapp.cn/simple] 
-Component     Description           Size        Version 
-fc            阿里云函数计算基础组件    100 MB       0.1.27
-devsapp/fc    阿里云函数计算基础组件    100 MB       0.1.27
-devsapp/fc    阿里云函数计算基础组件    100 MB       0.1.27
-fc-api        函数计算api操作组件      100 MB       0.0.44
-
-🔎  github registry [https://api.github.com/repos]
-Component     Description           Size        Version 
-fc            阿里云函数计算基础组件    100 MB       0.1.27
-devsapp/fc    阿里云函数计算基础组件    100 MB       0.1.27
-
-```
-
-
-## 注意事项
-
-在查询组件时，系统只会显示当前 Registry 与默认的 Github Reigstry 信息。如果需要查看其他 Reigstry 的信息，需要先通过`s set registry`进行 Reigstry 的切换