关于 audio_pr_create
audio_pr_create 是面向 OpenHarmony multimedia_audio_framework 贡献者的 PR 流程技能。它按仓库规范检查 Git 与 oh-gc 设置,并依次创建 ISSUE、提交 PR;创建后还可按需触发构建。
主要功能
- 01检查远端仓库和 fork 配置
- 02初始化 oh-gc CLI
- 03按条件提交或 amend 并推送
- 04根据模板创建 ISSUE
- 05创建关联 ISSUE 的 PR
- 06可按需启动 PR 构建
适用场景
- 01为音频框架代码修改准备提交和推送
- 02为新贡献创建 ISSUE 并关联 PR
- 03更新已有 PR 而不重复创建
- 04创建 PR 后请求启动构建
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ openharmonyinsight/ openharmony-skills --skill audio_pr_create安装后在 Claude Code 中输入/audio_pr_create确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
assets/config.jsonassets/ISSUE_TEMPLATE/config.ymlquestion.ymlsecurity-issue.ymlfeature-request.ymlbug-report.ymlassets/PR_TEMPLATE/PULL_REQUEST_TEMPLATE.zh-CN.mdreferences/Readme.md详细介绍
来自项目 README初始化
- 查看当前是否配置令牌,如果没有配置,用
./assets/config.json中的'username'和'token'进行git的配置
git config --global credential.helper store
初始化仓库
- 采用
git remote -v查看当前远端仓库是否存在,远端仓库一般下列形式:
upstream https://gitcode.com/openharmony/multimedia_audio_framework (fetch)
upstream https://gitcode.com/openharmony/multimedia_audio_framework (push)
- 查看fork仓库是否添加,fork仓库格式为: "https://gitcode.com/{username}/{repo}.git"其中,{username}和{repo}为`./assets/config.json`中的'username'和'token',fork仓库一般命名为origin,
如果没有,使用
git remote add加上
初始化oh-gc CLI
- 参考
./references/Readme.md进行oh-gc的初始化,其中登录使用的token采用./assets/config.json的token
提交注意事项
- 判断当前代码是否有更新
- 查看一下当前用户是否已经git commit过,如果用户已经commit,则push到远端fork仓库,否则,帮助用户进行commit操作,注意!!
git commit时必须要加上-s,-m的信息中添加"Co-Authored-By: Agent",提交后进行push到origin的fork仓库 - 查看当前是否已经存在相关PR,如果当前修改只是修改上一笔PR的代码,则直接采用
git commit --amend后进行push注意添加 -f 不需要重新创建PR,直接结束当前技能。否则进行push,并开始下面的PR的创建 - 遵循创建流程,先创建ISSURE然后将ISSUE绑定到PR之中
创建流程
Step1.创建ISSUE
// title根据当此任务以及修改确认
// body根据指定的labels选择`assets/ISSUE_TEMPLATE`中的指定模板,必须选择模板,不能自己生成,body中的内容需要进行填充,模板中的版本选择master
// labels需要和模板匹配
// repo为 owner/repo
oh-gc issue:create --repo openharmony/multimedia_audio_framework --title "test cli" --body "test cli" --labels "bug"
如果成功创建则获得返回:"https://gitcode.com/openharmony/multimedia_audio_framework/issues/11908" 记录其中的"issue_id"为11908
Step2.创建PR
参数配置
- title需要根据当此任务以及修改确认
- head为当前提交分支
- body选择
assets/PR_TEMPLATE/PULL_REQUEST_TEMPLATE.zh-CN.md并根据内容将模板中的自检结果更新,其中IssueNo字段应该填写创建ISSUE中返回的ISSUE url. **通用规范自检:**字段必须根据本次修改进行填写自检结果,|Y/N/NA|必须选择其中一个进行填写 - repo为 owner/repo
- base一般为 master
oh-gc pr:create --repo openharmony/multimedia_audio_framework --head feature --base master --title "PR标题" --body body
如果创建成功则返回:"Created PR #14486: PR标题" 失败,则去查询pr中是否存在已经创建好的,如果存在则返回,如果不存在则直接返回失败原因告知用户,结束流程.
Step3.开始构建
成功创建PR后,询问用户是否需要开始构建? 用户否认,则退出流程。 用户需要,则等待PR完全初始化后,等30s,帮助用户开始构建
oh-gc pr:comment 14486 --body "start build"
如果失败,进行重试,重试3次之后如果依旧失败,则告知用户失败原因并退出。
评论
支持 Markdown