一、概述
OHPM(OpenHarmony Package Manager)由OpenHarmony三方库中心仓网站、命令行工具、OpenHarmony三方库中心仓仓库三个部分组成,其功能如下:
-
OpenHarmony三方库中心仓网站(website):用于检索、查看所需 OpenHarmony 三方库信息,也可管理关于 ohpm 的个人配置
-
命令行工具(cli):OpenHarmony 三方库的包管理工具
-
OpenHarmony三方库中心仓仓库(registry):存储三方库软件及其元数据的仓库
官网传送门:ohpm.openharmony.cn 请自行完成OHPM账号注册与登录。
二、创建Static Library模块
DevEco Studio 路径: New -> Module
三、oh-package.json5
描述包名和版本等信息,此处的 name、version、description、author、main、license都是必须配置的。
json
{
"name": "xxx",
"version": "0.0.1",
"description": "致力于提供一个一致性、模块化、高性能的实用工具库。通过提供的工具函数,降低array、function、object的使用难度,减少重复性工作。",
"main": "index.ets",
"author": "xxx<xxx@aa.com>",
"license": "MIT",
"dependencies": {}
}
四、构建HAR包
构建时一定要注意,此时是发布到OHPM的开源包,Libray root下build_profile.json5文件中定义产物类型时artifactType必须缺省或original。
json
{
"buildOption": {
// 此处的artifactType可以缺省或者设置为original
"artifactType": "original"
},
}
-
选中对应的Library包,点击 Build -> Make Module 'xxx'
-
构建成功后,产物目录:build/default/outputs/default/xxx.har
五、发布准备
1. Library root目录必须具备以下文件
-
README.md - 描述包信息
-
LICENSE文件 - 说明遵守的开源协议
-
changelog.md - 说明每个version的变化
2. OHPM 公钥
OpenHarmony 三方库中心仓 和 ohpm-cli 命令行工具的通信(查询、下载、发布),需要建立可信的安全通道,可以按如下步骤进行配置 OHPM 公钥。
shell
ssh-keygen -m PEM -t RSA -b 4096 -f ~/.ssh_ohpm/mykey
如果没有.ssh_ohpm目录,手动创建即可
注意:在生成key的时候会有个输入passphrase的环节,此处不允许为空,后续执行 ohpm publish 会使用到passphrase进行验证
请将公钥上传至OpenHarmony三方库中心仓【个人中心】-【认证管理】下:点击页面左上角的"新增"按钮,并将公钥文件(mykey.pub)的内容粘贴到公钥输入框中。
传送门:ohpm.openharmony.cn/#/cn/person...
3. 配置publish_id和key_path
获取publish_id:
登录OpenHarmony三方库中心仓,从 【个人中心】页面中【复制发布码】
传送门:ohpm.openharmony.cn/#/cn/person...
获取key_path:
即上面生成公钥时的文件 ~/.ssh_ohpm/mykey
两种配置方式:
- 在Library root目录下 .ohpmrc 文件中配置
shell
publish_id = xxxxxx
key_path = your_key_path
- 直接在命令行中配置全局
shell
ohpm config set publish_id your_publish_id
ohpm config set key_path your_key_path
六、发布
- 执行发布命令
shell
ohpm publish build/default/outputs/default/xxx.har
执行到该处时,会将har文件中的所有Contents进行展示
- 输入 passphrase,与上文中配置的key_path对应的
- 发布成功后,进入人审环节,人审成功后即可使用
传送门:ohpm.openharmony.cn/#/cn/person...
七、发布失败的一些问题
- 缺少LICENSE开源声明文件:ohpm ERROR: HttpCode 400 The OHPM package must contain a non-empty license file.
- 缺少README.md说明文件:ohpm ERROR: HttpCode 400 The OHPM package must contain a non-empty readme.md file.
- 缺少CHANGELOG.md版本说明文件:ohpm ERROR: HttpCode 400 The OHPM package must contain a non-empty changelog.md file.