鸿蒙技术分享:怎么发布自己的ohpm包
前言 本文章描述了如何发布自己的ohpm包 目录 前言1.创建项目和模块2.配置库模块中的 oh-package.json5 文件3.创建描述必要文件3.1 README.md3.2 CHANGELOG.md3.3 LICENSE 文件4.编写模块代码,并将模块打包为HAR包4.1将工程级build-profile.json5中的useNormalizedOHMUrl字段设置为false。4.2配
前言
本文章描述了如何发布自己的ohpm包
目录 前言1.创建项目和模块2.配置库模块中的 oh-package.json5 文件3.创建描述必要文件3.1 README.md3.2 CHANGELOG.md3.3 LICENSE 文件4.编写模块代码,并将模块打包为HAR包4.1将工程级build-profile.json5中的useNormalizedOHMUrl字段设置为false。4.2配置debug模式4.3选择模块并构建5.在OpenHarmony三方库中心仓上进行认证管理。5.1创建公私匙文件5.2上传公钥5.3配置私钥6.发布配置6.1配置publish_id 6.2配置发布地址7.发布注意事项
1.创建项目和模块
打开DevEco Studio创建一个项目,然后创建一个库模块,选择static library。
开发静态资源包官方文档:开发静态共享包-开发及引用共享包-应用/元服务开发-DevEco Studio - 华为HarmonyOS开发者
创建项目后新建模块
2.配置库模块中的 oh-package.json5 文件
关于oh-package.json5文件配置参考官方文档:oh-package.json5-ohpm-Command Line Tools - 华为HarmonyOS开发者
对于库名称的规则参考:OpenHarmony三方库中心仓
其中 包名称:name、版本号:version、入口:main、开源协议:license为必选配置项
3.创建描述必要文件
3.1 README.md
在库模块的根目录中,创建一个 README.md 文件,描述您三方库的代码以及如何使用它,文件不能为空。
README.md文件中必须包含如何使用你开发的ohpm包,包括下载命令和基本使用,否则无法上架
3.2 CHANGELOG.md
在库模块的根目录中,创建一个 CHANGELOG.md 文件,描述您三方库的代码不同版本的变更内容,文件不能为空。
CHANGELOG.md文件必须包含对每一个版本的描述,否则无法上架
3.3 LICENSE 文件
在库模块的根目录中,创建一个 LICENSE 文件,指定该软件包可以在什么样的许可下被使用、修改和共享,文件不能为空。
此处LICENSE文件内容需要与第二步中oh-package.json5中的license相同,如:第二步中将license配置为“MIT”,则此处LICENSE文件内容则为MIT协议
4.编写模块代码,并将模块打包为HAR包
关于详细构建HAR包可参考官方文档:构建HAR-配置构建-编译构建-DevEco Studio - 华为HarmonyOS开发者
此处以debug模式构建HAR为例子
4.1将工程级build-profile.json5中的useNormalizedOHMUrl字段设置为false。
说明:使用DevEco Studio NEXT Beta1(5.0.3.800)之前的版本,工程级build-profile.json5的useNormalizedOHMUrl字段默认值为false,无需执行本步骤。
{
"app": {
"products": [
{
"buildOption": {
"strictMode": {
"useNormalizedOHMUrl": false
}
}
}
]
}
}
4.2配置debug模式
点击DevEco Studio右上角图标,Build Mode选择debug。默认为模式:在编译App时使用release模式,编译HAP/HSP/HAR时使用debug模式。
4.3选择模块并构建
选择开发完的模块,并且构建
5.在OpenHarmony三方库中心仓上进行认证管理。
认证管理官方文档:OpenHarmony三方库中心仓
5.1创建公私匙文件
利用工具 ssh-keygen 生成公、私钥文件,可执行以下命令:
ssh-keygen -m PEM -t RSA -b 4096 -f ~/.ssh_ohpm/mykey
说明: ~/.ssh_ohpm/mykey 为私钥文件mykey的文件路径,按照实际情况指定。指定的私钥存储目录必须存在。追加了.pub 后缀的相应公钥文件会在与私钥相同的目录中生成。
可直接在DevEco 终端执行上述命令,建议将密钥文件新建一个空位夹存放
执行该命令需要设置密码,此密码将在发布ohpm包时使用
执行成功后将生成私钥和公钥文件
5.2上传公钥
将公钥上传至OpenHarmony三方库中心仓【个人中心】-【认证管理】下:点击页面左上角的“新增”按钮,并将公钥文件(mykey.pub)的内容粘贴到公钥输入框中。
5.3配置私钥
将对应私钥文件路径配置到 .ohpmrc 文件中 key_path 字段上,可执行以下命令进行配置:
ohpm config set key_path ~/.ssh_ohpm/mykey
可直接在DevEco 终端执行上述命令,
6.发布配置
6.1配置publish_id
登录OpenHarmony三方库中心仓,从 【个人中心】页面中【复制发布码】,并配置到 .ohpmrc 文件中 publish_id 字段上,可执行如下命令:
ohpm config set publish_id your_publish_id
可直接在DevEco 终端执行上述命令
6.2配置发布地址
执行此条命令:
ohpm config set publish_registry https://ohpm.openharmony.cn/ohpm
7.发布
执行如下命令发布HAR,<HAR路径>请指定为待发布HAR的具体路径
ohpm publish <HAR路径>
HAR路径为第四步中构建的HAR包路径
执行该命令后需要输入第五步设置的密码
执行成功后可在个人中心查看审核进度
注意事项
1.建议在OpenHarmony三方库中心仓个人中心创建一个组织,并在配置包名时使用组织发布
2.README.md文件必须包含如何使用此包(install命令和代码使用)和简要介绍
3.每次更新发布都要更改oh-package.json5 中version的版本,而且要在CHANGELOG.md文件中添加对新版本的描述
更多推荐
所有评论(0)