publish workflow (#25)

* publish workflow

Signed-off-by: zxypro1 <[email protected]>

* update workflow
feat: remove `project` in `env.yaml`

Signed-off-by: zxypro1 <[email protected]>

* publish: [email protected], [email protected]

Signed-off-by: zxypro1 <[email protected]>

---------

Signed-off-by: zxypro1 <[email protected]>

.github/workflows/publish-pkg.yml

@@ -0,0 +1,61 @@
+name: Publish Packages
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'packages/*/package.json'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        package:
+          - component-interface
+          - component-manager
+          - credential
+          - diff
+          - downloads
+          - engine
+          - ignore-walk
+          - load-application
+          - load-component
+          - logger
+          - orm
+          - parse-spec
+          - progress-bar
+          - registry
+          - utils
+          - zip
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Node.js
+      uses: actions/setup-node@v2
+      with:
+        node-version: '14'
+
+    - name: Install dependencies
+      run: npm run install:all
+
+    - name: Build packages
+      run: npm run build
+
+    - name: Publish package
+      run: |
+        PACKAGE_DIR=packages/${{ matrix.package }}
+        PACKAGE_JSON="${PACKAGE_DIR}/package.json"
+
+        # 检查 package.json 是否被修改
+        if git diff HEAD^ HEAD --name-only | grep -q "${PACKAGE_JSON}"; then
+          echo "Publishing ${{ matrix.package }}..."
+          cd $PACKAGE_DIR
+          npm run pub
+        else
+          echo "No changes in ${{ matrix.package }}/package.json"
+      env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.github/workflows/release.yml

@@ -0,0 +1,25 @@
+name: Release
+
+permissions:
+  contents: write
+
+on:
+  push:
+    tags:
+      - '*@*' # 书写格式：[email protected]
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+
+      - run: npx changelogithub # or [email protected] if ensure the stable result
+        env:
+          GITHUB_TOKEN: ${{secrets.CUSTOM_GITHUB_TOKEN}}

README.md

@@ -1,6 +1,56 @@
 # toolkit for serverless-devs
 
-## [@serverless-devs/downloads](./packages/downloads/README.md)
+![整体架构图](./assets/overall-arch.png)
+
+### [@serverless-devs/downloads](./packages/downloads/README.md)
+
 - 下载，支持文件解压等功能
-## [@serverless-devs/load-application](./packages/load-application/README.md)
-- 下载应用, 仅适用于serverless源的应用。
+
+### [@serverless-devs/load-application](./packages/load-application/README.md)
+
+- 下载应用, 仅适用于serverless源的应用。
+
+### [@serverless-devs/engine](./packages/engine/README.md)
+
+- 核心，掌管所有第三方组件命令的具体执行。
+
+### [@serverless-devs/parse-spec](./packages/parse-spec/README.md)
+
+- 配置文件解析，任务编排，处理后交由Engine执行。
+
+### [@serverless-devs/logger](./packages/logger/README.md)
+
+- 掌管全局日志的输入和输出，读取和写入。
+
+### [@serverless-devs/credential](./packages/credential/README.md)
+
+- 全局身份认证。
+
+### [@serverless-devs/load-component](./packages/load-component/README.md)
+
+- 从下载源中下载特定组件。目前只保留了serverless registry源
+
+### [@serverless-devs/registry](./packages/registry/README.md)
+
+- Serverless Registry内容管理
+
+## 开发
+
+```shell
+npm run install:all #依赖安装
+npm run build #编译所有包
+npm run test #测试
+```
+
+## 发布
+
+### 发布到npm
+
+- 修改package.json中的版本号。
+- 提pr到main。确保通过ci。
+- 合并后，将触发流水线自动发布。
+
+### Github Release
+
+- 打tag并上传，格式为`xxx(包名，如engine)@x.x.x(版本号，如0.0.1)`。
+- 将自动触发流水线进行release。

packages/engine/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serverless-devs/engine",
-  "version": "0.0.25",
+  "version": "0.0.26",
   "description": "a engine lib for serverless-devs",
   "main": "lib/index.js",
   "scripts": {

packages/parse-spec/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serverless-devs/parse-spec",
-  "version": "0.0.21",
+  "version": "0.0.22",
   "description": "a parse yaml spec lib for serverless-devs",
   "main": "lib/index.js",
   "scripts": {

packages/parse-spec/src/contants/index.ts

@@ -6,3 +6,5 @@ export const REGXG = /\${([\w\W]*?)}/g;
 export const ENVIRONMENT_KEY = 'env';
 export const ENVIRONMENT_FILE_NAME = 'env.yaml';
 export const ENVIRONMENT_FILE_PATH = path.join(utils.getRootHome(), 'cache', 'default-env.json');
+// Aliyun Serverless Devs 远程项目名称
+export const ALIYUN_REMOTE_PROJECT_ENV_PARAM = 'ALIYUN_DEVS_REMOTE_PROJECT_NAME';

packages/parse-spec/src/index.ts

@@ -140,7 +140,10 @@ class ParseSpec {
           trackerType: ETrackerType.parseException,
         });
       }
-      const { project, environments } = envYamlContent;
+      const { environments } = envYamlContent;
+      // 若存在环境变量，默认项目为devsProject
+      const devsProject = process.env.ALIYUN_DEVS_REMOTE_PROJECT_NAME;
+      const project = devsProject ? devsProject : get(this.yaml.content, 'name');
       const defaultEnvContent = require(ENVIRONMENT_FILE_PATH);
       const defaultEnv = get(find(defaultEnvContent, { project: project }), 'default');
       // project is not found in default-env.json
@@ -178,7 +181,10 @@ class ParseSpec {
       });
     }
     debug(`environment content: ${JSON.stringify(envYamlContent)}`);
-    const { project, environments } = envYamlContent;
+    const { environments } = envYamlContent;
+    // 若存在环境变量，默认项目为devsProject
+    const devsProject = process.env.ALIYUN_DEVS_REMOTE_PROJECT_NAME;
+    const project = devsProject ? devsProject : get(this.yaml.content, 'name');
     const environment = find(environments, item => item.name === this.record.env);
     // env name is not found
     if (isEmpty(environment)) {