From 4221d36bae06f072e03fcb5c2c9650a283427bcd Mon Sep 17 00:00:00 2001 From: LeoFang Date: Thu, 29 Oct 2020 17:03:29 +0800 Subject: [PATCH] Update README for necessary settings and introductions --- README.en.md | 6 +++++- README.md | 25 ++++++++++++++++++------- 2 files changed, 23 insertions(+), 8 deletions(-) diff --git a/README.en.md b/README.en.md index 277c2502..ab4de4a9 100644 --- a/README.en.md +++ b/README.en.md @@ -59,7 +59,8 @@ DONE! than you can create a Pull Request. pip3 install python-rpm-spec (ver>=0.10) pip3 install PyYAML (ver>=5.3.1) pip3 install requests (ver>=2.24.0) - yum install rpmdevtools + yum install rpmdevtools (ver>=8.3) + pip3 install beautifulsoup4 (ver>=4.9.3) ##### 2. json file config ~/.gitee_personal_token.json @@ -73,6 +74,9 @@ DONE! than you can create a Pull Request. ##### 4. OBS config if not config, please refer: https://openeuler.org/zh/docs/20.09/docs/ApplicationDev/%E6%9E%84%E5%BB%BARPM%E5%8C%85.html +##### 5. Python enviroment config + if in development, you want to use the tool directly, please config Python path firstly: source ./develop_env.sh + #### Use Instructions ##### 1. simple_update_robot.py single package auto-upgrade: python3 simple_update_robot.py -u pkg pkg_name branch_name diff --git a/README.md b/README.md index cc7f8d6d..e09c23dd 100644 --- a/README.md +++ b/README.md @@ -10,19 +10,25 @@ openEuler-Advisor 的目标是为 openEuler 制品仓的日常工作提供自动 2、advisors：这个目录中提供了一些自动化脚本，其中包括： -2.1、oa_upgradable.py 这个 python 脚本基于upstream-info，对比制品仓中软件相比社区上游最新版本的差异。 +2.1、oa_upgradable.py 这个 python 脚本基于upstream-info，用于查询软件包上游社区版本信息及版本推荐。 -2.2、simple_update_robot.py 这个 python 脚本基于原有 spec 文件信息，下载社区上游指定版本，并生成新的 spec 文件和相应的 PR。 +2.2、simple_update_robot.py 这个 python 脚本用于src-openeuler中软件包自动升级，包括：下载推荐版本源码包、修改spec、本地obs编译、创建PR及issue等。 2.3、check_missing_specs.py 这个 python 脚本，对 src-openeuler 中各2个仓库进行巡检。如果发现仓库中还不存在 spec 文件，可以直接创建相应仓库中的任务。 -2.4、check_licenses.py 这个试验性的 python 脚本对指定软件组件中 spec 文件内指定的 license 和 软件tar包内的 license 做交叉验证。 +2.4、check_source_url.py 这个 python 脚本，对src-openeuler中各个软件包的source地址进行检查，如果地址无效或不正确，自动创建issue提示修改。 -2.5、create_repo.py 和 create_repo_with_srpm 这两个 python 脚本提供了批量创建新 repo 的功能。2.6、check_abi.py 这个python脚本可以比较新老版本的rpm包，生成两个版本ABI差异分析结果。 +2.5、create_repo.py 和 create_repo_with_srpm 这两个 python 脚本提供了批量创建新 repo 的功能。 -2.6、which_archived.py用于检查制品仓软件的上游社区是否已经处于归档状态，便于维护团队及时调整包维护策略。 +2.6、which_archived.py 用于检查制品仓软件的上游社区是否已经处于归档状态，便于维护团队及时调整包维护策略。 -2.7、review_tool.py用于生成指定软件仓PR的代码审视清单，以规范化PR审视过程。 +2.7、check_repeated_repo.py 用于检查src-openeuler中可能重复的软件包。 + +2.8、psrtool.py 用于查询软件包归属SIG及某个SIG管理的软件包列表信息 + +2.9、tc_reminder.py 用于自动为openeuler中TC成员创建提示信息 + +2.10、review_tool.py 用于生成指定软件仓PR的代码审视清单，以规范化PR审视过程。 ## 2、后续计划 @@ -152,7 +158,8 @@ tag中版本的间隔符，如果 tag是 v1_0_1，然后配置separator 为"_" pip3 install python-rpm-spec (ver>=0.10) pip3 install PyYAML (ver>=5.3.1) pip3 install requests (ver>=2.24.0) - yum install rpmdevtools + yum install rpmdevtools (ver>=8.3) + pip3 install beautifulsoup4 (ver>=4.9.3) ##### b. json文件配置 创建json文件：~/.gitee_personal_token.json @@ -165,6 +172,10 @@ tag中版本的间隔符，如果 tag是 v1_0_1，然后配置separator 为"_" ##### d. OBS配置 如果未配置, 请参考：https://openeuler.org/zh/docs/20.09/docs/ApplicationDev/%E6%9E%84%E5%BB%BARPM%E5%8C%85.html + +##### e. Python环境配置 + 如果处于开发态，直接使用该工具，首先需要配置Python环境路径：source ./develop_env.sh + #### 3.2.2 使用说明 ##### a. simple_update_robot.py -- Gitee