V3

.github/workflows/registry-publish.yml

@@ -1,33 +1,31 @@
-name: publish package to serverless-hub
+name: publish package to registry
 
 on:
-  release:
-    types: [created]
+  push:
+    branches:
+      - V3
 
 jobs:
-  deploy:
+  release:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v2
+      - run: git config --global core.symlinks false
+        shell: bash
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v2
         with:
-          python-version: '3.x'
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 12
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install setuptools wheel twine
-          pip install requests
-      - name: Add publish file
+          sudo apt-get update
+          sudo apt-get install -y git make jq curl wget
+      - name: install s
+        run: |
+          npm i @serverless-devs/s@v3 -g
+      - name: s registry login
         run: |
-          wget https://serverless-registry.oss-cn-hangzhou.aliyuncs.com/publish-file/python3/hub-publish.py
-          ls
-      - name: Publish package
-        env:
-          publish_token: ${{ secrets.alibaba_registry_publish_token }}
+          s registry login --token ${{ secrets.alibaba_registry_v3_publish_token }}
+      - name: release prod
         run: |
-          ls
-          python hub-publish.py
+          s registry publish

.gitignore

@@ -1 +1,2 @@
-.s
+.s
+git-statistics.sh

publish.yaml

@@ -1,10 +1,13 @@
-Type: Application
-Name: start-unzip-oss
-Version: 0.0.19
+Edition: 3.0.0
+Type: Project
+Name: start-unzip-oss-v3
+Version: 0.0.15
 Provider:
   - 阿里云
-Description: 使用函数计算自动解压上传到OSS指定前缀目录的zip文件
+Description: 本案例是将解压zip文件工具 unzip，快速创建并部署到阿里云函数计算 FC。
 HomePage: https://github.com/devsapp/start-unzip-oss
+Organization: 阿里云函数计算（FC）
+Effective: Public
 Tags:
   - OSS上zip文件自动解压
   - 函数计算 OSS 触发器
@@ -13,15 +16,14 @@ Service:
   函数计算:
     Authorities:
       - AliyunFCFullAccess
-  OSS:
+  对象存储:
     Authorities:
       - AliyunOSSFullAccess
 Parameters:
   type: object
   additionalProperties: false # 不允许增加其他属性
   required: # 必填项
     - region
-    - serviceName
     - functionName
     - roleArn
     - bucketName
@@ -50,38 +52,30 @@ Parameters:
         - ap-southeast-3
         - ap-southeast-5
         - ap-northeast-1
+        - ap-northeast-2
         - eu-central-1
         - eu-west-1
         - us-west-1
         - us-east-1
         - ap-south-1
-    serviceName:
-      title: 服务名
-      type: string
-      default: unzip-oss
-      pattern: "^[a-zA-Z_][a-zA-Z0-9-_]{0,127}$"
-      description: 应用所属的函数计算服务,只能包含字母、数字、下划线和中划线。不能以数字、中划线开头。长度在 1-128 之间
+        - me-central-1
     functionName:
       title: 函数名
       type: string
-      default: oss-invoke-fc
-      pattern: "^[a-zA-Z_][a-zA-Z0-9-_]{0,63}$"
-      description: 应用的函数名称, 只能包含字母、数字、下划线和中划线。不能以数字、中划线开头。长度在 1-64 之间
+      default: oss-invoke-fc-${default-suffix}
+      pattern: "^[a-zA-Z_][a-zA-Z0-9-_]{0,127}$"
+      description: 应用的函数名称, 只能包含字母、数字、下划线和中划线。不能以数字、中划线开头。长度在 1-128 之间
     roleArn:
       title: RAM角色ARN
       type: string
       default: ""
-      pattern: "^acs:ram::[0-9]*:role/.*$"
-      description: "函数计算访问其他云服务时使用的服务角色，需要填写具体的角色ARN，格式为acs:ram::$account-id>:role/$role-name。例如：acs:ram::14310000000:role/aliyunfcdefaultrole。
-      \n如果您没有特殊要求，可以使用函数计算提供的默认的服务角色，即AliyunFCDefaultRole, 并增加 AliyunOSSFullAccess 权限。如果您首次使用函数计算，可以访问 https://fcnext.console.aliyun.com 进行授权。
-      \n详细文档参考 https://help.aliyun.com/document_detail/181589.html#section-o93-dbr-z6o"
+      description: "函数计算访问对象存储OSS服务时使用的函数角色"
       required: true
       x-role:
-        name: fcunzipossrole
+        name: fcossrole
         service: fc
         authorities:
           - AliyunOSSFullAccess
-          - AliyunFCDefaultRolePolicy
     bucketName:
       title: OSS存储桶名
       type: string
@@ -93,12 +87,12 @@ Parameters:
     prefix:
       title: 前缀
       type: string
-      default: src
+      default: src/
       description: 配置触发函数计算的文件前缀。您上传指定前缀的ZIP文件或将ZIP文件上传至指定目录会触发函数计算。置空此项则匹配所有上传的ZIP文件，置空此项可能会触发循环执行，建议您配置文件前缀。
     processedDir:
       title: 解压目标目录
       type: string
-      default: dst
+      default: dst/
       description: 将匹配到的文件解压到此目标目录下。为防止循环触发产生不必要的费用，建议您设置不同于前缀的目标目录。
     retainFileName:
       title: 是否保留压缩文件名为路径目录
@@ -112,7 +106,6 @@ Parameters:
       title: 触发器RAM角色ARN
       type: string
       default: AliyunOSSEventNotificationRole
-      pattern: "^acs:ram::[0-9]*:role/.*$"
       description: OSS使用此角色来发送事件通知来调用函数
       required: true
       x-role:

readme.md

@@ -1 +1,149 @@
-src/readme.md
+
+> 注：当前项目为 Serverless Devs 应用，由于应用中会存在需要初始化才可运行的变量（例如应用部署地区、函数名等等），所以**不推荐**直接 Clone 本仓库到本地进行部署或直接复制 s.yaml 使用，**强烈推荐**通过 `s init ${模版名称}` 的方法或应用中心进行初始化，详情可参考[部署 & 体验](#部署--体验) 。
+
+# start-unzip-oss-v3 帮助文档
+
+<description>
+
+本案例是将解压zip文件工具 unzip，快速创建并部署到阿里云函数计算 FC。
+
+</description>
+
+<codeUrl>
+
+
+
+</codeUrl>
+<preview>
+
+
+
+</preview>
+
+
+## 前期准备
+
+使用该项目，您需要有开通以下服务并拥有对应权限：
+
+<service>
+
+
+
+| 服务/业务 |  权限  | 相关文档 |
+| --- |  --- | --- |
+| 函数计算 |  AliyunFCFullAccess | [帮助文档](https://help.aliyun.com/product/2508973.html) [计费文档](https://help.aliyun.com/document_detail/2512928.html) |
+| 对象存储 |  AliyunOSSFullAccess | [帮助文档](https://help.aliyun.com/zh/oss) [计费文档](https://help.aliyun.com/zh/oss/product-overview/billing) |
+
+</service>
+
+<remark>
+
+
+
+</remark>
+
+<disclaimers>
+
+
+
+</disclaimers>
+
+## 部署 & 体验
+
+<appcenter>
+
+- :fire: 通过 [Serverless 应用中心](https://fcnext.console.aliyun.com/applications/create?template=start-unzip-oss-v3) ，
+  [![Deploy with Severless Devs](https://img.alicdn.com/imgextra/i1/O1CN01w5RFbX1v45s8TIXPz_!!6000000006118-55-tps-95-28.svg)](https://fcnext.console.aliyun.com/applications/create?template=start-unzip-oss-v3) 该应用。
+
+</appcenter>
+<deploy>
+
+- 通过 [Serverless Devs Cli](https://docs.serverless-devs.com/user-guide/install) 进行部署：
+  - [安装 Serverless Devs Cli 开发者工具](https://docs.serverless-devs.com/user-guide/install) ，并进行[授权信息配置]( https://docs.serverless-devs.com/user-guide/config) ；
+  - 初始化项目：`s init start-unzip-oss-v3 -d start-unzip-oss-v3`
+  - 进入项目，并进行项目部署：`cd start-unzip-oss-v3 && s deploy -y`
+
+</deploy>
+
+## 案例介绍
+
+<appdetail id="flushContent">
+
+本案例是将zip文件进行 unzip 解压，快速创建并部署到阿里云函数计算 FC。
+
+匹配解压规则的ZIP文件在上传到OSS后，会自动触发函数计算进行解压。文件解压完成后，会存储至OSS的指定目录中。
+
+- 建议使用 UTF-8 或 GB 2312 编码命名您的文件或文件夹，否则可能会出现解压后的文件或文件夹名称出现乱码、解压过程中断等问题。
+
+- 归档或冷归档类型的文件需先解冻再解压。
+
+- 建议 ZIP 包 + zip包里面最大单文件的大小之和不要超过 10 GB，否则解压失败。如果出现这个场景， 请参考：[unzip-oss-with-nas](https://github.com/zhaohang88/unzip-oss-nas)
+
+- 默认设置的函数执行时长为6小时， 如果不满足需求， 自己直接调整函数的 timeout,  最大可到 24小时
+
+    ![](https://help-static-aliyun-doc.aliyuncs.com/assets/img/zh-CN/5901957271/CAEQNBiBgMCKx9z24RgiIGMyMTE2ZDczNmNkYjQ2ZmI4MDNkYmYwMDIyZWE0ODkx3963382_20230830144006.372.svg)
+
+</appdetail>
+
+## 使用流程
+
+<usedetail id="flushContent">
+
+### 查看部署的案例
+
+部署时， 选择的OSS存储桶名，以及前缀名，如：
+
+![](https://img.alicdn.com/imgextra/i4/O1CN01KYL4lB1Obdl63LB39_!!6000000001724-0-tps-2336-1108.jpg)
+
+
+部署完成后，在oss对象存储中找到相应的OSS存储桶名，向该存储桶上传zip文件，如：
+
+![](https://img.alicdn.com/imgextra/i2/O1CN01ew8GAi1pDomkNrcuC_!!6000000005327-0-tps-1874-850.jpg)
+
+在控制台就可以查看到调用日志，如：
+
+![](https://img.alicdn.com/imgextra/i4/O1CN01Yv7Jsc1UJfur6G0WU_!!6000000002497-0-tps-2842-776.jpg)
+
+#### 参数说明
+
+![](https://img.alicdn.com/imgextra/i3/O1CN014DqNwc1jgmBgXBzqW_!!6000000004578-0-tps-1592-760.jpg)
+
+#### 配置示例
+![](https://img.alicdn.com/imgextra/i4/O1CN01WYPc2X1wcjhUAXa65_!!6000000006329-0-tps-1596-876.jpg)
+
+
+### 二次开发
+您可以通过云端控制台的开发功能进行二次开发。如果您之前是在本地创建的项目案例，也可以在本地项目目录`start-unzip-oss-v3`文件夹下，对项目进行二次开发。开发完成后，可以通过`s deploy`进行快速部署。
+
+上面的示例, 解压保存回去的都还是本身触发函数的 OSS， 如果是保存到其他 OSS， 直接将 `bucket.put_object(newKey + name, file_obj)` 这样上传回 oss 的代码修改下即可， 比如：
+
+```python
+auth = oss2.Auth('<yourAccessKeyId>', '<yourAccessKeySecret>')
+dst_bucket_name = "xxx-bucket"
+dst_bucket = oss2.Bucket(auth, endpoint, dst_bucket_name)
+dst_bucket.put_object(newKey +  name, file_obj)
+
+```
+
+</usedetail>
+
+## 注意事项
+
+<matters id="flushContent">
+</matters>
+
+
+<devgroup>
+
+
+## 开发者社区
+
+您如果有关于错误的反馈或者未来的期待，您可以在 [Serverless Devs repo Issues](https://github.com/serverless-devs/serverless-devs/issues) 中进行反馈和交流。如果您想要加入我们的讨论组或者了解 FC 组件的最新动态，您可以通过以下渠道进行：
+
+<p align="center">  
+
+| <img src="https://img.alicdn.com/imgextra/i2/O1CN010Sk7sv1Xl6WuOb6uU_!!6000000002963-0-tps-666-662.jpg" width="130px" > | <img src="https://img.alicdn.com/imgextra/i4/O1CN010Vt5aw27VN5rJIguB_!!6000000007802-0-tps-668-630.jpg" width="130px" > |
+| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| <center>微信公众号：`serverless`</center>                                                                                         | <center>钉钉交流群：`33947367`</center>                                                                                           |
+</p>
+</devgroup>