Package Exports

urtc-sdk
urtc-sdk/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (urtc-sdk) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

UCloudRTC SDK

API 和 SDK 使用说明文档

当前项目说明

一、开发

执行

npm install
npm run dev

开发时，会自动检测源码文件的变更，自动生成开发环境使用的文件到 lib/index.js

二、编译

执行

npm install
npm run build

构建后，会自动生成可用于生产环境使用的文件到 lib/index.js

三、发版到 npm

首先，克隆本代码库，即公司内部使用的 gitlab 服务器上的 urtc-sdk-web 代码库到本地的某个目录下，假设为 DIR 目录
```
git clone git@git.ucloudadmin.com:urtc/sdk/urtc-sdk-web.git
```
然后，克隆 github 上的代码库，即 urtc-sdk-web 到 DIR 目录，（注：由于两个代码库重名，所以在 clone github 上的代码库时，需要指定目录别名为 urtc-sdk-web-github ）
```
git clone git@github.com:ucloud/urtc-sdk-web.git urtc-sdk-web-github
```
```
最终需要是这种目录结构：
   |- DIR
      |- urtc-sdk-web
      |- urtc-sdk-web-github
```
注：urtc-sdk-web 里的 publish.sh 脚本根据上面的目录关系去寻找 urtc-sdk-web-github，并将本代码库中的 API.md，Manual.md 和构建后的 index.js 等文件自动拷贝到 urtc-sdk-web-github 中，并修改其中的 package.json 文件中的版本号等。
接下来，进入 urtc-sdk-web 目录，手动更新 src/version.ts 里的版本号
再然后，执行 urtc-sdk-web 里的 publish.sh 脚本
```
./publish.sh
```
最后，到 urtc-sdk-web-github 里，检查无误后按上一步最后打印出的提示步骤操作即可完成发版

commit 规范

[feat] - 增加新功能(feature) [fix] - bug修复 [hotfix] - 紧急bug修复 [test] - 添加/修改测试 [doc] - 添加/修改文档 [refact] - 重构（即不是新增功能，也不是修改bug的代码变动） [chore] - 构建过程或辅助工具的变动特别地，发版时脚本自动生成的 bump x.x.x